|
73 | 73 | "shape": "InternalServerException" |
74 | 74 | } |
75 | 75 | ], |
76 | | - "documentation": "<p>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.</p> <p>Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.</p>" |
| 76 | + "documentation": "<p>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.</p> <p>Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.</p> <p>Use this API or <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html\">UpdateDomain</a> to enable <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">identity resolution</a>: set <code>Matching</code> to true. </p>" |
77 | 77 | }, |
78 | 78 | "CreateProfile": { |
79 | 79 | "name": "CreateProfile", |
|
383 | 383 | "shape": "InternalServerException" |
384 | 384 | } |
385 | 385 | ], |
386 | | - "documentation": "<p>This API is in preview release for Amazon Connect and subject to change.</p> <p>Before calling this API, use <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html\">CreateDomain</a> or <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html\">UpdateDomain</a> to enable identity resolution: set <code>Matching</code> to true.</p> <p>GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process. </p> <important> <p>Amazon Connect runs a batch process every Saturday at 12AM UTC to identify matching profiles. The results are returned up to seven days after the Saturday run.</p> </important> <p>Amazon Connect uses the following profile attributes to identify matches:</p> <ul> <li> <p>PhoneNumber</p> </li> <li> <p>HomePhoneNumber</p> </li> <li> <p>BusinessPhoneNumber</p> </li> <li> <p>MobilePhoneNumber</p> </li> <li> <p>EmailAddress</p> </li> <li> <p>PersonalEmailAddress</p> </li> <li> <p>BusinessEmailAddress</p> </li> <li> <p>FullName</p> </li> <li> <p>BusinessName</p> </li> </ul>" |
| 386 | + "documentation": "<p>This API is in preview release for Amazon Connect and subject to change.</p> <p>Before calling this API, use <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html\">CreateDomain</a> or <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html\">UpdateDomain</a> to enable identity resolution: set <code>Matching</code> to true.</p> <p>GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process. </p> <important> <p>Amazon Connect starts a batch process every Saturday at 12AM UTC to identify matching profiles. The results are returned up to seven days after the Saturday run.</p> </important> <p>Amazon Connect uses the following profile attributes to identify matches:</p> <ul> <li> <p>PhoneNumber</p> </li> <li> <p>HomePhoneNumber</p> </li> <li> <p>BusinessPhoneNumber</p> </li> <li> <p>MobilePhoneNumber</p> </li> <li> <p>EmailAddress</p> </li> <li> <p>PersonalEmailAddress</p> </li> <li> <p>BusinessEmailAddress</p> </li> <li> <p>FullName</p> </li> <li> <p>BusinessName</p> </li> </ul> <p>For example, two or more profiles—with spelling mistakes such as <b>John Doe</b> and <b>Jhn Doe</b>, or different casing email addresses such as <b> [email protected]</b> and <b> [email protected]</b>, or different phone number formats such as <b>555-010-0000</b> and <b>+1-555-010-0000</b>—can be detected as belonging to the same customer <b>John Doe</b> and merged into a unified profile.</p>" |
387 | 387 | }, |
388 | 388 | "GetProfileObjectType": { |
389 | 389 | "name": "GetProfileObjectType", |
|
889 | 889 | "shape": "InternalServerException" |
890 | 890 | } |
891 | 891 | ], |
892 | | - "documentation": "<p>Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.</p> <p>After a domain is created, the name can’t be changed.</p>" |
| 892 | + "documentation": "<p>Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.</p> <p>After a domain is created, the name can’t be changed.</p> <p>Use this API or <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html\">CreateDomain</a> to enable <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">identity resolution</a>: set <code>Matching</code> to true. </p>" |
893 | 893 | }, |
894 | 894 | "UpdateProfile": { |
895 | 895 | "name": "UpdateProfile", |
|
1105 | 1105 | }, |
1106 | 1106 | "Matching": { |
1107 | 1107 | "shape": "MatchingRequest", |
1108 | | - "documentation": "<p>The process of matching duplicate profiles. This process runs every Saturday at 12AM.</p>" |
| 1108 | + "documentation": "<p>The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">GetMatches</a> API to return and review the results. </p>" |
1109 | 1109 | }, |
1110 | 1110 | "Tags": { |
1111 | 1111 | "shape": "TagMap", |
|
1140 | 1140 | }, |
1141 | 1141 | "Matching": { |
1142 | 1142 | "shape": "MatchingResponse", |
1143 | | - "documentation": "<p>The process of matching duplicate profiles. This process runs every Saturday at 12AM.</p>" |
| 1143 | + "documentation": "<p>The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">GetMatches</a> API to return and review the results. </p>" |
1144 | 1144 | }, |
1145 | 1145 | "CreatedAt": { |
1146 | 1146 | "shape": "timestamp", |
|
1722 | 1722 | }, |
1723 | 1723 | "Matching": { |
1724 | 1724 | "shape": "MatchingResponse", |
1725 | | - "documentation": "<p>The process of matching duplicate profiles. This process runs every Saturday at 12AM.</p>" |
| 1725 | + "documentation": "<p>The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">GetMatches</a> API to return and review the results. </p>" |
1726 | 1726 | }, |
1727 | 1727 | "CreatedAt": { |
1728 | 1728 | "shape": "timestamp", |
|
2326 | 2326 | "ProfileId": { |
2327 | 2327 | "shape": "uuid", |
2328 | 2328 | "documentation": "<p>The unique identifier of a customer profile.</p>" |
| 2329 | + }, |
| 2330 | + "ObjectFilter": { |
| 2331 | + "shape": "ObjectFilter", |
| 2332 | + "documentation": "<p>Applies a filter to the response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset and _case.</p>" |
2329 | 2333 | } |
2330 | 2334 | } |
2331 | 2335 | }, |
|
2484 | 2488 | "max": 512, |
2485 | 2489 | "pattern": "\\S+" |
2486 | 2490 | }, |
| 2491 | + "ObjectFilter": { |
| 2492 | + "type": "structure", |
| 2493 | + "required": [ |
| 2494 | + "KeyName", |
| 2495 | + "Values" |
| 2496 | + ], |
| 2497 | + "members": { |
| 2498 | + "KeyName": { |
| 2499 | + "shape": "name", |
| 2500 | + "documentation": "<p>A searchable identifier of a standard profile object. The predefined keys you can use to search for _asset include: _assetId, _assetName, _serialNumber. The predefined keys you can use to search for _case include: _caseId.</p>" |
| 2501 | + }, |
| 2502 | + "Values": { |
| 2503 | + "shape": "requestValueList", |
| 2504 | + "documentation": "<p>A list of key values.</p>" |
| 2505 | + } |
| 2506 | + }, |
| 2507 | + "documentation": "<p>The filter applied to ListProfileObjects response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset and _case.</p>" |
| 2508 | + }, |
2487 | 2509 | "ObjectTypeField": { |
2488 | 2510 | "type": "structure", |
2489 | 2511 | "members": { |
|
2507 | 2529 | "members": { |
2508 | 2530 | "StandardIdentifiers": { |
2509 | 2531 | "shape": "StandardIdentifierList", |
2510 | | - "documentation": "<p>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.</p>" |
| 2532 | + "documentation": "<p>The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET or CASE means that this key can be used to tie an object to a PROFILE, ASSET or CASE respectively. 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.</p>" |
2511 | 2533 | }, |
2512 | 2534 | "FieldNames": { |
2513 | 2535 | "shape": "FieldNameList", |
|
3190 | 3212 | "type": "string", |
3191 | 3213 | "enum": [ |
3192 | 3214 | "PROFILE", |
| 3215 | + "ASSET", |
| 3216 | + "CASE", |
3193 | 3217 | "UNIQUE", |
3194 | 3218 | "SECONDARY", |
3195 | 3219 | "LOOKUP_ONLY", |
|
3462 | 3486 | }, |
3463 | 3487 | "Matching": { |
3464 | 3488 | "shape": "MatchingRequest", |
3465 | | - "documentation": "<p>The process of matching duplicate profiles. This process runs every Saturday at 12AM.</p>" |
| 3489 | + "documentation": "<p>The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">GetMatches</a> API to return and review the results. </p>" |
3466 | 3490 | }, |
3467 | 3491 | "Tags": { |
3468 | 3492 | "shape": "TagMap", |
|
3496 | 3520 | }, |
3497 | 3521 | "Matching": { |
3498 | 3522 | "shape": "MatchingResponse", |
3499 | | - "documentation": "<p>The process of matching duplicate profiles. This process runs every Saturday at 12AM.</p>" |
| 3523 | + "documentation": "<p>The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">GetMatches</a> API to return and review the results. </p>" |
3500 | 3524 | }, |
3501 | 3525 | "CreatedAt": { |
3502 | 3526 | "shape": "timestamp", |
|
0 commit comments