DeleteProfileObjectType
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.
Request Syntax
DELETE /domains/DomainName/object-types/ObjectTypeName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
DomainName (p. 41)
The unique name of the domain.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[a-zA-Z0-9_-]+$
Required: Yes ObjectTypeName (p. 41)
The name of the profile object type.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z_][a-zA-Z_0-9-]*$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "Message": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
Message (p. 41)
A message that indicates the delete request is done.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 229).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403 BadRequestException
The input you provided is invalid.
HTTP Status Code: 400 InternalServerException
An internal service error occurred.
HTTP Status Code: 500 ResourceNotFoundException
The requested resource does not exist, or access was denied.
HTTP Status Code: 404 ThrottlingException
You exceeded the maximum number of requests.
HTTP Status Code: 429
Examples
Example
This example illustrates one usage of DeleteProfileObjectType.
Sample Request
DELETE /domains/ExampleDomainName/object-types/MyCustomObjectTypeName HTTP/1.1
Sample Response
Content-type: application/json { "Message": "Deleted"
}
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteWorkflow
DeleteWorkflow
Deletes the specified workflow and all its corresponding resources. This is an async process.
Request Syntax
DELETE /domains/DomainName/workflows/WorkflowId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
DomainName (p. 44)
The unique name of the domain.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[a-zA-Z0-9_-]+$
Required: Yes WorkflowId (p. 44)
Unique identifier for the workflow.
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 229).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403
See Also
BadRequestException
The input you provided is invalid.
HTTP Status Code: 400 InternalServerException
An internal service error occurred.
HTTP Status Code: 500 ResourceNotFoundException
The requested resource does not exist, or access was denied.
HTTP Status Code: 404 ThrottlingException
You exceeded the maximum number of requests.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetAutoMergingPreview
GetAutoMergingPreview
Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly selects a sample of matching groups from the existing matching results, and applies the automerging settings that you provided. You can then view the number of profiles in the sample, the number of matches, and the number of profiles identified to be merged. This enables you to evaluate the accuracy of the attributes in your matching list.
You can't view which profiles are matched and would be merged.
Important
We strongly recommend you use this API to do a dry run of the automerging process before running the Identity Resolution Job. Include at least two matching attributes. If your matching list includes too few attributes (such as only FirstName or only LastName), there may be a large number of matches. This increases the chances of erroneous merges.
Request Syntax
POST /domains/DomainName/identity-resolution-jobs/auto-merging-preview HTTP/1.1 Content-type: application/json
{
"ConflictResolution": {
"ConflictResolvingModel": "string", "SourceName": "string"
},
"Consolidation": {
"MatchingAttributesList": [ [ "string" ]
] }}
URI Request Parameters
The request uses the following URI parameters.
DomainName (p. 46)
The unique name of the domain.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[a-zA-Z0-9_-]+$
Required: Yes
Request Body
The request accepts the following data in JSON format.
ConflictResolution (p. 46)
How the auto-merging process should resolve conflicts between different profiles.
Type: ConflictResolution (p. 168) object
Response Syntax
Required: Yes Consolidation (p. 46)
A list of matching attributes that represent matching criteria.
Type: Consolidation (p. 171) object Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"DomainName": "string",
"NumberOfMatchesInSample": number, "NumberOfProfilesInSample": number, "NumberOfProfilesWillBeMerged": number }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
DomainName (p. 47)
The unique name of the domain.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[a-zA-Z0-9_-]+$
NumberOfMatchesInSample (p. 47)
The number of match groups in the domain that have been reviewed in this preview dry run.
Type: Long
NumberOfProfilesInSample (p. 47)
The number of profiles found in this preview dry run.
Type: Long
NumberOfProfilesWillBeMerged (p. 47)
The number of profiles that would be merged if this wasn't a preview dry run.
Type: Long
Errors
For information about the errors that are common to all actions, see Common Errors (p. 229).
See Also
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403 BadRequestException
The input you provided is invalid.
HTTP Status Code: 400 InternalServerException
An internal service error occurred.
HTTP Status Code: 500 ResourceNotFoundException
The requested resource does not exist, or access was denied.
HTTP Status Code: 404 ThrottlingException
You exceeded the maximum number of requests.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetDomain
GetDomain
Returns information about a specific domain.
Request Syntax
GET /domains/DomainName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
DomainName (p. 49)
The unique name of the domain.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[a-zA-Z0-9_-]+$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "CreatedAt": number,
"DeadLetterQueueUrl": "string", "DefaultEncryptionKey": "string", "DefaultExpirationDays": number, "DomainName": "string",
"LastUpdatedAt": number, "Matching": {
Response Elements
"MeteringProfileCount": number, "ObjectCount": number,
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
CreatedAt (p. 49)
The timestamp of when the domain was created.
Type: Timestamp DeadLetterQueueUrl (p. 49)
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
DefaultEncryptionKey (p. 49)
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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
DefaultExpirationDays (p. 49)
The default number of days until the data within the domain expires.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1098.
DomainName (p. 49)
The unique name of the domain.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Errors
Pattern: ^[a-zA-Z0-9_-]+$
LastUpdatedAt (p. 49)
The timestamp of when the domain was most recently edited.
Type: Timestamp Matching (p. 49)
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.
Type: MatchingResponse (p. 199) object Stats (p. 49)
Usage-specific statistics about the domain.
Type: DomainStats (p. 172) object Tags (p. 49)
The tags used to organize, track, or control access for this resource.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Maximum length of 256.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 229).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403 BadRequestException
The input you provided is invalid.
HTTP Status Code: 400 InternalServerException
An internal service error occurred.
HTTP Status Code: 500 ResourceNotFoundException
The requested resource does not exist, or access was denied.
See Also
HTTP Status Code: 404 ThrottlingException
You exceeded the maximum number of requests.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetIdentityResolutionJob
GetIdentityResolutionJob
Returns information about an Identity Resolution Job in a specific domain.
Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see Use Identity Resolution to consolidate similar profiles.
Request Syntax
GET /domains/DomainName/identity-resolution-jobs/JobId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
DomainName (p. 53)
The unique name of the domain.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[a-zA-Z0-9_-]+$
Required: Yes JobId (p. 53)
The unique identifier of the Identity Resolution Job.
Pattern: [a-f0-9]{32}
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "AutoMerging": {
"ConflictResolution": {
"ConflictResolvingModel": "string", "SourceName": "string"
},
"Consolidation": {
"MatchingAttributesList": [ [ "string" ]
] },
"Enabled": boolean },
"DomainName": "string",
Response Elements
"ExportingLocation": { "S3Exporting": {
"S3BucketName": "string", "S3KeyName": "string"
} },
"JobEndTime": number, "JobExpirationTime": number, "JobId": "string",
"JobStartTime": number, "JobStats": {
"NumberOfMatchesFound": number, "NumberOfMergesDone": number, "NumberOfProfilesReviewed": number },
"LastUpdatedAt": number, "Message": "string", "Status": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
AutoMerging (p. 53)
Configuration settings for how to perform the auto-merging of profiles.
Type: AutoMerging (p. 166) object DomainName (p. 53)
The unique name of the domain.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[a-zA-Z0-9_-]+$
ExportingLocation (p. 53)
The S3 location where the Identity Resolution Job writes result files.
Type: ExportingLocation (p. 174) object JobEndTime (p. 53)
The timestamp of when the Identity Resolution Job was completed.
Type: Timestamp JobExpirationTime (p. 53)
The timestamp of when the Identity Resolution Job will expire.
Type: Timestamp JobId (p. 53)
The unique identifier of the Identity Resolution Job.
Type: String
Errors
Pattern: [a-f0-9]{32}
JobStartTime (p. 53)
The timestamp of when the Identity Resolution Job was started or will be started.
Type: Timestamp JobStats (p. 53)
Statistics about the Identity Resolution Job.
Type: JobStats (p. 186) object LastUpdatedAt (p. 53)
The timestamp of when the Identity Resolution Job was most recently edited.
Type: Timestamp Message (p. 53)
The error messages that are generated when the Identity Resolution Job runs.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: .*
Status (p. 53)
The status of the Identity Resolution Job.
• PENDING: The Identity Resolution Job is scheduled but has not started yet. If you turn off the Identity Resolution feature in your domain, jobs in the PENDING state are deleted.
• PREPROCESSING: The Identity Resolution Job is loading your data.
• FIND_MATCHING: The Identity Resolution Job is using the machine learning model to identify profiles that belong to the same matching group.
• MERGING: The Identity Resolution Job is merging duplicate profiles.
• COMPLETED: The Identity Resolution Job completed successfully.
• PARTIAL_SUCCESS: There's a system error and not all of the data is merged. The Identity Resolution Job writes a message indicating the source of the problem.
• FAILED: The Identity Resolution Job did not merge any data. It writes a message indicating the source of the problem.
Type: String
Valid Values: PENDING | PREPROCESSING | FIND_MATCHING | MERGING | COMPLETED | PARTIAL_SUCCESS | FAILED
Errors
For information about the errors that are common to all actions, see Common Errors (p. 229).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403
See Also
BadRequestException
The input you provided is invalid.
HTTP Status Code: 400 InternalServerException
An internal service error occurred.
HTTP Status Code: 500 ResourceNotFoundException
The requested resource does not exist, or access was denied.
HTTP Status Code: 404 ThrottlingException
You exceeded the maximum number of requests.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetIntegration
GetIntegration
Returns an integration for a domain.
Request Syntax
POST /domains/DomainName/integrations HTTP/1.1 Content-type: application/json
{
"Uri": "string"
}
URI Request Parameters
The request uses the following URI parameters.
DomainName (p. 57)
The unique name of the domain.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[a-zA-Z0-9_-]+$
Required: Yes
Request Body
The request accepts the following data in JSON format.
Uri (p. 57)
The URI of the S3 bucket or any other type of data source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json { "CreatedAt": number,
"DomainName": "string", "LastUpdatedAt": number, "ObjectTypeName": "string", "ObjectTypeNames": { "string" : "string"
},
"Tags": {
Response Elements
"string" : "string"
},
"Uri": "string", "WorkflowId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
CreatedAt (p. 57)
The timestamp of when the domain was created.
Type: Timestamp DomainName (p. 57)
The unique name of the domain.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[a-zA-Z0-9_-]+$
LastUpdatedAt (p. 57)
The timestamp of when the domain was most recently edited.
Type: Timestamp ObjectTypeName (p. 57)
The name of the profile object type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z_][a-zA-Z_0-9-]*$
ObjectTypeNames (p. 57)
A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event.
It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 255.
Value Length Constraints: Minimum length of 1. Maximum length of 255.
Value Pattern: ^[a-zA-Z_][a-zA-Z_0-9-]*$
Tags (p. 57)
The tags used to organize, track, or control access for this resource.
Type: String to string map
Errors
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Maximum length of 256.
Uri (p. 57)
The URI of the S3 bucket or any other type of data source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
WorkflowId (p. 57)
Unique identifier for the workflow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 229).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403 BadRequestException
The input you provided is invalid.
HTTP Status Code: 400 InternalServerException
An internal service error occurred.
HTTP Status Code: 500 ResourceNotFoundException
The requested resource does not exist, or access was denied.
HTTP Status Code: 404 ThrottlingException
You exceeded the maximum number of requests.
HTTP Status Code: 429
Examples
Example
This example illustrates one usage of GetIntegration.
See Also
Sample Request
GET /domains/ExampleDomainName/integrations HTTP/1.1
Sample Response
Content-type: application/json {
"CreatedAt": 1479249799770,
"DomainName": "ExampleDomainName", "LastUpdatedAt": 1479249799770, "ObjectTypeName": "MyCustomObject",
"Uri": "arn:aws:flow:us-east-1:123456789012:URIOfIntegration1"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetMatches
GetMatches
Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: set Matching to true.
GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process.
Important
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.
Amazon Connect uses the following profile attributes to identify matches:
• PhoneNumber
• HomePhoneNumber
• BusinessPhoneNumber
• MobilePhoneNumber
• EmailAddress
• PersonalEmailAddress
• BusinessEmailAddress
• FullName
For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing email addresses such as [email protected] and [email protected], or different phone number formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.
Request Syntax
GET /domains/DomainName/matches?max-results=MaxResults&next-token=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
DomainName (p. 61)
The unique name of the domain.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[a-zA-Z0-9_-]+$
Required: Yes MaxResults (p. 61)
The maximum number of results to return per page.
Request Body
Valid Range: Minimum value of 1. Maximum value of 100.
NextToken (p. 61)
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "Matches": [
{
"ConfidenceScore": number, "MatchId": "string", "ProfileIds": [ "string" ] }
],
"MatchGenerationDate": number, "NextToken": "string",
"PotentialMatches": number }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Matches (p. 62)
The list of matched profiles for this instance.
Type: Array of MatchItem (p. 200) objects MatchGenerationDate (p. 62)
The timestamp this version of Match Result generated.
Type: Timestamp NextToken (p. 62)
If there are additional results, this is the token for the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
PotentialMatches (p. 62)
The number of potential matches found.
Errors
Type: Integer
Valid Range: Minimum value of 0.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 229).
AccessDeniedException
You do not have sufficient access to perform this action.
You do not have sufficient access to perform this action.