@aws-sdk/client-customer-profiles 3.600.0 → 3.606.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -5
- package/dist-cjs/index.js +7 -0
- package/dist-es/protocols/Aws_restJson1.js +7 -0
- package/dist-types/CustomerProfiles.d.ts +6 -5
- package/dist-types/CustomerProfilesClient.d.ts +6 -5
- package/dist-types/commands/CreateCalculatedAttributeDefinitionCommand.d.ts +4 -4
- package/dist-types/commands/CreateDomainCommand.d.ts +9 -2
- package/dist-types/commands/CreateEventStreamCommand.d.ts +4 -4
- package/dist-types/commands/CreateIntegrationWorkflowCommand.d.ts +2 -3
- package/dist-types/commands/DeleteCalculatedAttributeDefinitionCommand.d.ts +4 -3
- package/dist-types/commands/DeleteWorkflowCommand.d.ts +2 -1
- package/dist-types/commands/GetCalculatedAttributeDefinitionCommand.d.ts +2 -1
- package/dist-types/commands/GetProfileObjectTypeCommand.d.ts +2 -0
- package/dist-types/commands/GetSimilarProfilesCommand.d.ts +4 -3
- package/dist-types/commands/ListProfileObjectTypesCommand.d.ts +2 -0
- package/dist-types/commands/PutIntegrationCommand.d.ts +1 -1
- package/dist-types/commands/PutProfileObjectTypeCommand.d.ts +4 -1
- package/dist-types/commands/SearchProfilesCommand.d.ts +5 -4
- package/dist-types/commands/UpdateCalculatedAttributeDefinitionCommand.d.ts +3 -3
- package/dist-types/index.d.ts +6 -5
- package/dist-types/models/models_0.d.ts +227 -137
- package/dist-types/ts3.4/models/models_0.d.ts +7 -0
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -8,11 +8,12 @@ AWS SDK for JavaScript CustomerProfiles Client for Node.js, Browser and React Na
|
|
|
8
8
|
|
|
9
9
|
<fullname>Amazon Connect Customer Profiles</fullname>
|
|
10
10
|
|
|
11
|
-
<p>Amazon Connect Customer Profiles is a unified customer profile for your contact
|
|
12
|
-
pre-built connectors powered by AppFlow that make it easy to combine
|
|
13
|
-
from third party applications, such as Salesforce (CRM), ServiceNow
|
|
14
|
-
enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
|
|
15
|
-
|
|
11
|
+
<p>Amazon Connect Customer Profiles is a unified customer profile for your contact
|
|
12
|
+
center that has pre-built connectors powered by AppFlow that make it easy to combine
|
|
13
|
+
customer information from third party applications, such as Salesforce (CRM), ServiceNow
|
|
14
|
+
(ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. </p>
|
|
15
|
+
<p>For more information about the Amazon Connect Customer Profiles feature, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/customer-profiles.html">Use Customer
|
|
16
|
+
Profiles</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>
|
|
16
17
|
|
|
17
18
|
## Installing
|
|
18
19
|
|
package/dist-cjs/index.js
CHANGED
|
@@ -1562,6 +1562,7 @@ var se_PutProfileObjectTypeCommand = /* @__PURE__ */ __name(async (input, contex
|
|
|
1562
1562
|
ExpirationDays: [],
|
|
1563
1563
|
Fields: (_) => (0, import_smithy_client._json)(_),
|
|
1564
1564
|
Keys: (_) => (0, import_smithy_client._json)(_),
|
|
1565
|
+
MaxProfileObjectCount: [],
|
|
1565
1566
|
SourceLastUpdatedTimestampFormat: [],
|
|
1566
1567
|
Tags: (_) => (0, import_smithy_client._json)(_),
|
|
1567
1568
|
TemplateId: []
|
|
@@ -2113,6 +2114,8 @@ var de_GetProfileObjectTypeCommand = /* @__PURE__ */ __name(async (output, conte
|
|
|
2113
2114
|
Fields: import_smithy_client._json,
|
|
2114
2115
|
Keys: import_smithy_client._json,
|
|
2115
2116
|
LastUpdatedAt: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
|
|
2117
|
+
MaxAvailableProfileObjectCount: import_smithy_client.expectInt32,
|
|
2118
|
+
MaxProfileObjectCount: import_smithy_client.expectInt32,
|
|
2116
2119
|
ObjectTypeName: import_smithy_client.expectString,
|
|
2117
2120
|
SourceLastUpdatedTimestampFormat: import_smithy_client.expectString,
|
|
2118
2121
|
Tags: import_smithy_client._json,
|
|
@@ -2459,6 +2462,8 @@ var de_PutProfileObjectTypeCommand = /* @__PURE__ */ __name(async (output, conte
|
|
|
2459
2462
|
Fields: import_smithy_client._json,
|
|
2460
2463
|
Keys: import_smithy_client._json,
|
|
2461
2464
|
LastUpdatedAt: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
|
|
2465
|
+
MaxAvailableProfileObjectCount: import_smithy_client.expectInt32,
|
|
2466
|
+
MaxProfileObjectCount: import_smithy_client.expectInt32,
|
|
2462
2467
|
ObjectTypeName: import_smithy_client.expectString,
|
|
2463
2468
|
SourceLastUpdatedTimestampFormat: import_smithy_client.expectString,
|
|
2464
2469
|
Tags: import_smithy_client._json,
|
|
@@ -2851,6 +2856,8 @@ var de_ListProfileObjectTypeItem = /* @__PURE__ */ __name((output, context) => {
|
|
|
2851
2856
|
CreatedAt: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
|
|
2852
2857
|
Description: import_smithy_client.expectString,
|
|
2853
2858
|
LastUpdatedAt: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
|
|
2859
|
+
MaxAvailableProfileObjectCount: import_smithy_client.expectInt32,
|
|
2860
|
+
MaxProfileObjectCount: import_smithy_client.expectInt32,
|
|
2854
2861
|
ObjectTypeName: import_smithy_client.expectString,
|
|
2855
2862
|
Tags: import_smithy_client._json
|
|
2856
2863
|
});
|
|
@@ -657,6 +657,7 @@ export const se_PutProfileObjectTypeCommand = async (input, context) => {
|
|
|
657
657
|
ExpirationDays: [],
|
|
658
658
|
Fields: (_) => _json(_),
|
|
659
659
|
Keys: (_) => _json(_),
|
|
660
|
+
MaxProfileObjectCount: [],
|
|
660
661
|
SourceLastUpdatedTimestampFormat: [],
|
|
661
662
|
Tags: (_) => _json(_),
|
|
662
663
|
TemplateId: [],
|
|
@@ -1197,6 +1198,8 @@ export const de_GetProfileObjectTypeCommand = async (output, context) => {
|
|
|
1197
1198
|
Fields: _json,
|
|
1198
1199
|
Keys: _json,
|
|
1199
1200
|
LastUpdatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
1201
|
+
MaxAvailableProfileObjectCount: __expectInt32,
|
|
1202
|
+
MaxProfileObjectCount: __expectInt32,
|
|
1200
1203
|
ObjectTypeName: __expectString,
|
|
1201
1204
|
SourceLastUpdatedTimestampFormat: __expectString,
|
|
1202
1205
|
Tags: _json,
|
|
@@ -1543,6 +1546,8 @@ export const de_PutProfileObjectTypeCommand = async (output, context) => {
|
|
|
1543
1546
|
Fields: _json,
|
|
1544
1547
|
Keys: _json,
|
|
1545
1548
|
LastUpdatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
1549
|
+
MaxAvailableProfileObjectCount: __expectInt32,
|
|
1550
|
+
MaxProfileObjectCount: __expectInt32,
|
|
1546
1551
|
ObjectTypeName: __expectString,
|
|
1547
1552
|
SourceLastUpdatedTimestampFormat: __expectString,
|
|
1548
1553
|
Tags: _json,
|
|
@@ -1947,6 +1952,8 @@ const de_ListProfileObjectTypeItem = (output, context) => {
|
|
|
1947
1952
|
CreatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
1948
1953
|
Description: __expectString,
|
|
1949
1954
|
LastUpdatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
1955
|
+
MaxAvailableProfileObjectCount: __expectInt32,
|
|
1956
|
+
MaxProfileObjectCount: __expectInt32,
|
|
1950
1957
|
ObjectTypeName: __expectString,
|
|
1951
1958
|
Tags: _json,
|
|
1952
1959
|
});
|
|
@@ -370,11 +370,12 @@ export interface CustomerProfiles {
|
|
|
370
370
|
}
|
|
371
371
|
/**
|
|
372
372
|
* <fullname>Amazon Connect Customer Profiles</fullname>
|
|
373
|
-
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact
|
|
374
|
-
* pre-built connectors powered by AppFlow that make it easy to combine
|
|
375
|
-
* from third party applications, such as Salesforce (CRM), ServiceNow
|
|
376
|
-
* enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
|
|
377
|
-
*
|
|
373
|
+
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact
|
|
374
|
+
* center that has pre-built connectors powered by AppFlow that make it easy to combine
|
|
375
|
+
* customer information from third party applications, such as Salesforce (CRM), ServiceNow
|
|
376
|
+
* (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. </p>
|
|
377
|
+
* <p>For more information about the Amazon Connect Customer Profiles feature, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/customer-profiles.html">Use Customer
|
|
378
|
+
* Profiles</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>
|
|
378
379
|
* @public
|
|
379
380
|
*/
|
|
380
381
|
export declare class CustomerProfiles extends CustomerProfilesClient implements CustomerProfiles {
|
|
@@ -204,11 +204,12 @@ export interface CustomerProfilesClientResolvedConfig extends CustomerProfilesCl
|
|
|
204
204
|
}
|
|
205
205
|
/**
|
|
206
206
|
* <fullname>Amazon Connect Customer Profiles</fullname>
|
|
207
|
-
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact
|
|
208
|
-
* pre-built connectors powered by AppFlow that make it easy to combine
|
|
209
|
-
* from third party applications, such as Salesforce (CRM), ServiceNow
|
|
210
|
-
* enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
|
|
211
|
-
*
|
|
207
|
+
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact
|
|
208
|
+
* center that has pre-built connectors powered by AppFlow that make it easy to combine
|
|
209
|
+
* customer information from third party applications, such as Salesforce (CRM), ServiceNow
|
|
210
|
+
* (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. </p>
|
|
211
|
+
* <p>For more information about the Amazon Connect Customer Profiles feature, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/customer-profiles.html">Use Customer
|
|
212
|
+
* Profiles</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>
|
|
212
213
|
* @public
|
|
213
214
|
*/
|
|
214
215
|
export declare class CustomerProfilesClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, CustomerProfilesClientResolvedConfig> {
|
|
@@ -29,10 +29,10 @@ declare const CreateCalculatedAttributeDefinitionCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Creates a new calculated attribute definition. After creation, new object data ingested
|
|
31
31
|
* into Customer Profiles will be included in the calculated attribute, which can be retrieved
|
|
32
|
-
* for a profile using the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetCalculatedAttributeForProfile.html">GetCalculatedAttributeForProfile</a> API.
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
32
|
+
* for a profile using the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetCalculatedAttributeForProfile.html">GetCalculatedAttributeForProfile</a> API. Defining a calculated attribute makes it
|
|
33
|
+
* available for all profiles within a domain. Each calculated attribute can only reference
|
|
34
|
+
* one <code>ObjectType</code> and at most, two fields from that
|
|
35
|
+
* <code>ObjectType</code>.</p>
|
|
36
36
|
* @example
|
|
37
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
38
|
* ```javascript
|
|
@@ -30,13 +30,20 @@ declare const CreateDomainCommand_base: {
|
|
|
30
30
|
* <p>Creates a domain, which is a container for all customer data, such as customer profile
|
|
31
31
|
* attributes, object types, profile keys, and encryption keys. You can create multiple
|
|
32
32
|
* domains, and each domain can have multiple third-party integrations.</p>
|
|
33
|
-
* <p>Each Amazon Connect instance can be associated with only one domain. Multiple
|
|
34
|
-
*
|
|
33
|
+
* <p>Each Amazon Connect instance can be associated with only one domain. Multiple
|
|
34
|
+
* Amazon Connect instances can be associated with one domain.</p>
|
|
35
35
|
* <p>Use this API or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to
|
|
36
36
|
* enable <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">identity
|
|
37
37
|
* resolution</a>: set <code>Matching</code> to true.</p>
|
|
38
38
|
* <p>To prevent cross-service impersonation when you call this API, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html">Cross-service confused deputy prevention</a> for sample policies that you should
|
|
39
39
|
* apply. </p>
|
|
40
|
+
* <note>
|
|
41
|
+
* <p>It is not possible to associate a Customer Profiles domain with an Amazon Connect Instance directly from
|
|
42
|
+
* the API. If you would like to create a domain and associate a Customer Profiles domain, use the Amazon Connect
|
|
43
|
+
* admin website. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-customer-profiles.html#enable-customer-profiles-step1">Enable Customer Profiles</a>.</p>
|
|
44
|
+
* <p>Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances
|
|
45
|
+
* can be associated with one domain.</p>
|
|
46
|
+
* </note>
|
|
40
47
|
* @example
|
|
41
48
|
* Use a bare-bones client and the command you need to make an API call.
|
|
42
49
|
* ```javascript
|
|
@@ -27,10 +27,10 @@ declare const CreateEventStreamCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates an event stream, which is a subscription to real-time events, such as when
|
|
31
|
-
* updated through Amazon Connect Customer Profiles.</p>
|
|
32
|
-
* <p>Each event stream can be associated with only one Kinesis Data Stream destination in the
|
|
33
|
-
* Amazon Web Services account as the customer profiles domain</p>
|
|
30
|
+
* <p>Creates an event stream, which is a subscription to real-time events, such as when
|
|
31
|
+
* profiles are created and updated through Amazon Connect Customer Profiles.</p>
|
|
32
|
+
* <p>Each event stream can be associated with only one Kinesis Data Stream destination in the
|
|
33
|
+
* same region and Amazon Web Services account as the customer profiles domain</p>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
36
|
* ```javascript
|
|
@@ -27,9 +27,8 @@ declare const CreateIntegrationWorkflowCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
*
|
|
32
|
-
* </p>
|
|
30
|
+
* <p> Creates an integration workflow. An integration workflow is an async process which
|
|
31
|
+
* ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo. </p>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
34
|
* ```javascript
|
|
@@ -27,9 +27,10 @@ declare const DeleteCalculatedAttributeDefinitionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes an existing calculated attribute definition. Note that deleting a default
|
|
31
|
-
* is possible, however once deleted, you will be unable to undo that
|
|
32
|
-
*
|
|
30
|
+
* <p>Deletes an existing calculated attribute definition. Note that deleting a default
|
|
31
|
+
* calculated attribute is possible, however once deleted, you will be unable to undo that
|
|
32
|
+
* action and will need to recreate it on your own using the
|
|
33
|
+
* CreateCalculatedAttributeDefinition API if you want it back.</p>
|
|
33
34
|
* @example
|
|
34
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
36
|
* ```javascript
|
|
@@ -27,7 +27,8 @@ declare const DeleteWorkflowCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes the specified workflow and all its corresponding resources. This is an async
|
|
30
|
+
* <p>Deletes the specified workflow and all its corresponding resources. This is an async
|
|
31
|
+
* process.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -27,7 +27,8 @@ declare const GetCalculatedAttributeDefinitionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Provides more information on a calculated attribute definition for Customer
|
|
30
|
+
* <p>Provides more information on a calculated attribute definition for Customer
|
|
31
|
+
* Profiles.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -48,6 +48,8 @@ declare const GetProfileObjectTypeCommand_base: {
|
|
|
48
48
|
* // EncryptionKey: "STRING_VALUE",
|
|
49
49
|
* // AllowProfileCreation: true || false,
|
|
50
50
|
* // SourceLastUpdatedTimestampFormat: "STRING_VALUE",
|
|
51
|
+
* // MaxAvailableProfileObjectCount: Number("int"),
|
|
52
|
+
* // MaxProfileObjectCount: Number("int"),
|
|
51
53
|
* // Fields: { // FieldMap
|
|
52
54
|
* // "<keys>": { // ObjectTypeField
|
|
53
55
|
* // Source: "STRING_VALUE",
|
|
@@ -27,9 +27,10 @@ declare const GetSimilarProfilesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns a set of profiles that belong to the same matching group using the
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <p>Returns a set of profiles that belong to the same matching group using the
|
|
31
|
+
* <code>matchId</code> or <code>profileId</code>. You can also specify the type of
|
|
32
|
+
* matching that you want for finding similar profiles using either
|
|
33
|
+
* <code>RULE_BASED_MATCHING</code> or <code>ML_BASED_MATCHING</code>.</p>
|
|
33
34
|
* @example
|
|
34
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
36
|
* ```javascript
|
|
@@ -48,6 +48,8 @@ declare const ListProfileObjectTypesCommand_base: {
|
|
|
48
48
|
* // Description: "STRING_VALUE", // required
|
|
49
49
|
* // CreatedAt: new Date("TIMESTAMP"),
|
|
50
50
|
* // LastUpdatedAt: new Date("TIMESTAMP"),
|
|
51
|
+
* // MaxProfileObjectCount: Number("int"),
|
|
52
|
+
* // MaxAvailableProfileObjectCount: Number("int"),
|
|
51
53
|
* // Tags: { // TagMap
|
|
52
54
|
* // "<keys>": "STRING_VALUE",
|
|
53
55
|
* // },
|
|
@@ -31,7 +31,7 @@ declare const PutIntegrationCommand_base: {
|
|
|
31
31
|
* Amazon AppFlow and Amazon Connect.</p>
|
|
32
32
|
* <p>An integration can belong to only one domain.</p>
|
|
33
33
|
* <p>To add or remove tags on an existing Integration, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html"> TagResource
|
|
34
|
-
*
|
|
34
|
+
* </a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">
|
|
35
35
|
* UntagResource</a>.</p>
|
|
36
36
|
* @example
|
|
37
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,7 +29,7 @@ declare const PutProfileObjectTypeCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Defines a ProfileObjectType.</p>
|
|
31
31
|
* <p>To add or remove tags on an existing ObjectType, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html">
|
|
32
|
-
*
|
|
32
|
+
* TagResource</a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -45,6 +45,7 @@ declare const PutProfileObjectTypeCommand_base: {
|
|
|
45
45
|
* EncryptionKey: "STRING_VALUE",
|
|
46
46
|
* AllowProfileCreation: true || false,
|
|
47
47
|
* SourceLastUpdatedTimestampFormat: "STRING_VALUE",
|
|
48
|
+
* MaxProfileObjectCount: Number("int"),
|
|
48
49
|
* Fields: { // FieldMap
|
|
49
50
|
* "<keys>": { // ObjectTypeField
|
|
50
51
|
* Source: "STRING_VALUE",
|
|
@@ -78,6 +79,8 @@ declare const PutProfileObjectTypeCommand_base: {
|
|
|
78
79
|
* // EncryptionKey: "STRING_VALUE",
|
|
79
80
|
* // AllowProfileCreation: true || false,
|
|
80
81
|
* // SourceLastUpdatedTimestampFormat: "STRING_VALUE",
|
|
82
|
+
* // MaxProfileObjectCount: Number("int"),
|
|
83
|
+
* // MaxAvailableProfileObjectCount: Number("int"),
|
|
81
84
|
* // Fields: { // FieldMap
|
|
82
85
|
* // "<keys>": { // ObjectTypeField
|
|
83
86
|
* // Source: "STRING_VALUE",
|
|
@@ -28,10 +28,11 @@ declare const SearchProfilesCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Searches for profiles within a specific domain using one or more predefined search keys
|
|
31
|
-
* (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A
|
|
32
|
-
* is a data type pair that consists of a <code>KeyName</code> and
|
|
33
|
-
*
|
|
34
|
-
*
|
|
31
|
+
* (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A
|
|
32
|
+
* search key is a data type pair that consists of a <code>KeyName</code> and
|
|
33
|
+
* <code>Values</code> list.</p>
|
|
34
|
+
* <p>This operation supports searching for profiles with a minimum of 1 key-value(s) pair and
|
|
35
|
+
* up to 5 key-value(s) pairs using either <code>AND</code> or <code>OR</code> logic.</p>
|
|
35
36
|
* @example
|
|
36
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
38
|
* ```javascript
|
|
@@ -27,9 +27,9 @@ declare const UpdateCalculatedAttributeDefinitionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates an existing calculated attribute definition. When updating the Conditions, note
|
|
31
|
-
* the date range of a calculated attribute will not trigger inclusion of
|
|
32
|
-
* current date range.</p>
|
|
30
|
+
* <p>Updates an existing calculated attribute definition. When updating the Conditions, note
|
|
31
|
+
* that increasing the date range of a calculated attribute will not trigger inclusion of
|
|
32
|
+
* historical data greater than the current date range.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* <fullname>Amazon Connect Customer Profiles</fullname>
|
|
3
|
-
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact
|
|
4
|
-
* pre-built connectors powered by AppFlow that make it easy to combine
|
|
5
|
-
* from third party applications, such as Salesforce (CRM), ServiceNow
|
|
6
|
-
* enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
|
|
7
|
-
*
|
|
3
|
+
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact
|
|
4
|
+
* center that has pre-built connectors powered by AppFlow that make it easy to combine
|
|
5
|
+
* customer information from third party applications, such as Salesforce (CRM), ServiceNow
|
|
6
|
+
* (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. </p>
|
|
7
|
+
* <p>For more information about the Amazon Connect Customer Profiles feature, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/customer-profiles.html">Use Customer
|
|
8
|
+
* Profiles</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>
|
|
8
9
|
*
|
|
9
10
|
* @packageDocumentation
|
|
10
11
|
*/
|
|
@@ -14,12 +14,9 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
14
14
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* <p>A data type pair that consists of a <code>KeyName</code> and <code>Values</code> list
|
|
18
|
-
* used in conjunction with the
|
|
19
|
-
*
|
|
20
|
-
* and
|
|
21
|
-
* <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-Values">Values</a>
|
|
22
|
-
* parameters to search for profiles using the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a> API.</p>
|
|
17
|
+
* <p>A data type pair that consists of a <code>KeyName</code> and <code>Values</code> list
|
|
18
|
+
* that is used in conjunction with the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-KeyName">KeyName</a> and <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-Values">Values</a> parameters to search for profiles using the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a>
|
|
19
|
+
* API.</p>
|
|
23
20
|
* @public
|
|
24
21
|
*/
|
|
25
22
|
export interface AdditionalSearchKey {
|
|
@@ -44,12 +41,11 @@ export interface AddProfileKeyRequest {
|
|
|
44
41
|
*/
|
|
45
42
|
ProfileId: string | undefined;
|
|
46
43
|
/**
|
|
47
|
-
* <p>A searchable identifier of a customer profile. The predefined keys you can use
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
* _shopifyOrderId.</p>
|
|
44
|
+
* <p>A searchable identifier of a customer profile. The predefined keys you can use include: _account, _profileId, _assetId,
|
|
45
|
+
* _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId,
|
|
46
|
+
* _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId,
|
|
47
|
+
* _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId,
|
|
48
|
+
* _segmentUserId, _shopifyCustomerId, _shopifyOrderId.</p>
|
|
53
49
|
* @public
|
|
54
50
|
*/
|
|
55
51
|
KeyName: string | undefined;
|
|
@@ -189,7 +185,9 @@ export interface Address {
|
|
|
189
185
|
PostalCode?: string;
|
|
190
186
|
}
|
|
191
187
|
/**
|
|
192
|
-
* <p>Batch defines the boundaries for ingestion for each step in
|
|
188
|
+
* <p>Batch defines the boundaries for ingestion for each step in
|
|
189
|
+
* <code>APPFLOW_INTEGRATION</code> workflow. <code>APPFLOW_INTEGRATION</code> workflow
|
|
190
|
+
* splits ingestion based on these boundaries.</p>
|
|
193
191
|
* @public
|
|
194
192
|
*/
|
|
195
193
|
export interface Batch {
|
|
@@ -776,12 +774,14 @@ export interface AppflowIntegration {
|
|
|
776
774
|
Batches?: Batch[];
|
|
777
775
|
}
|
|
778
776
|
/**
|
|
779
|
-
* <p>Structure holding all <code>APPFLOW_INTEGRATION</code> specific workflow
|
|
777
|
+
* <p>Structure holding all <code>APPFLOW_INTEGRATION</code> specific workflow
|
|
778
|
+
* attributes.</p>
|
|
780
779
|
* @public
|
|
781
780
|
*/
|
|
782
781
|
export interface AppflowIntegrationWorkflowAttributes {
|
|
783
782
|
/**
|
|
784
|
-
* <p>Specifies the source connector type, such as Salesforce, ServiceNow, and Marketo.
|
|
783
|
+
* <p>Specifies the source connector type, such as Salesforce, ServiceNow, and Marketo.
|
|
784
|
+
* Indicates source of ingestion.</p>
|
|
785
785
|
* @public
|
|
786
786
|
*/
|
|
787
787
|
SourceConnectorType: SourceConnectorType | undefined;
|
|
@@ -797,7 +797,8 @@ export interface AppflowIntegrationWorkflowAttributes {
|
|
|
797
797
|
RoleArn?: string;
|
|
798
798
|
}
|
|
799
799
|
/**
|
|
800
|
-
* <p>Workflow specific execution metrics for <code>APPFLOW_INTEGRATION</code>
|
|
800
|
+
* <p>Workflow specific execution metrics for <code>APPFLOW_INTEGRATION</code>
|
|
801
|
+
* workflow.</p>
|
|
801
802
|
* @public
|
|
802
803
|
*/
|
|
803
804
|
export interface AppflowIntegrationWorkflowMetrics {
|
|
@@ -840,7 +841,9 @@ export type Status = (typeof Status)[keyof typeof Status];
|
|
|
840
841
|
*/
|
|
841
842
|
export interface AppflowIntegrationWorkflowStep {
|
|
842
843
|
/**
|
|
843
|
-
* <p>Name of the flow created during execution of workflow step.
|
|
844
|
+
* <p>Name of the flow created during execution of workflow step.
|
|
845
|
+
* <code>APPFLOW_INTEGRATION</code> workflow type creates an appflow flow during workflow
|
|
846
|
+
* step execution on the customers behalf.</p>
|
|
844
847
|
* @public
|
|
845
848
|
*/
|
|
846
849
|
FlowName: string | undefined;
|
|
@@ -850,32 +853,38 @@ export interface AppflowIntegrationWorkflowStep {
|
|
|
850
853
|
*/
|
|
851
854
|
Status: Status | undefined;
|
|
852
855
|
/**
|
|
853
|
-
* <p>Message indicating execution of workflow step for <code>APPFLOW_INTEGRATION</code>
|
|
856
|
+
* <p>Message indicating execution of workflow step for <code>APPFLOW_INTEGRATION</code>
|
|
857
|
+
* workflow.</p>
|
|
854
858
|
* @public
|
|
855
859
|
*/
|
|
856
860
|
ExecutionMessage: string | undefined;
|
|
857
861
|
/**
|
|
858
|
-
* <p>Total number of records processed during execution of workflow step for
|
|
862
|
+
* <p>Total number of records processed during execution of workflow step for
|
|
863
|
+
* <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
859
864
|
* @public
|
|
860
865
|
*/
|
|
861
866
|
RecordsProcessed: number | undefined;
|
|
862
867
|
/**
|
|
863
|
-
* <p>Start datetime of records pulled in batch during execution of workflow step for
|
|
868
|
+
* <p>Start datetime of records pulled in batch during execution of workflow step for
|
|
869
|
+
* <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
864
870
|
* @public
|
|
865
871
|
*/
|
|
866
872
|
BatchRecordsStartTime: string | undefined;
|
|
867
873
|
/**
|
|
868
|
-
* <p>End datetime of records pulled in batch during execution of workflow step for
|
|
874
|
+
* <p>End datetime of records pulled in batch during execution of workflow step for
|
|
875
|
+
* <code>APPFLOW_INTEGRATION</code> workflow.</p>
|
|
869
876
|
* @public
|
|
870
877
|
*/
|
|
871
878
|
BatchRecordsEndTime: string | undefined;
|
|
872
879
|
/**
|
|
873
|
-
* <p>Creation timestamp of workflow step for <code>APPFLOW_INTEGRATION</code>
|
|
880
|
+
* <p>Creation timestamp of workflow step for <code>APPFLOW_INTEGRATION</code>
|
|
881
|
+
* workflow.</p>
|
|
874
882
|
* @public
|
|
875
883
|
*/
|
|
876
884
|
CreatedAt: Date | undefined;
|
|
877
885
|
/**
|
|
878
|
-
* <p>Last updated timestamp for workflow step for <code>APPFLOW_INTEGRATION</code>
|
|
886
|
+
* <p>Last updated timestamp for workflow step for <code>APPFLOW_INTEGRATION</code>
|
|
887
|
+
* workflow.</p>
|
|
879
888
|
* @public
|
|
880
889
|
*/
|
|
881
890
|
LastUpdatedAt: Date | undefined;
|
|
@@ -892,7 +901,8 @@ export interface AttributeItem {
|
|
|
892
901
|
Name: string | undefined;
|
|
893
902
|
}
|
|
894
903
|
/**
|
|
895
|
-
* <p>Mathematical expression and a list of attribute items specified in that
|
|
904
|
+
* <p>Mathematical expression and a list of attribute items specified in that
|
|
905
|
+
* expression.</p>
|
|
896
906
|
* @public
|
|
897
907
|
*/
|
|
898
908
|
export interface AttributeDetails {
|
|
@@ -902,7 +912,9 @@ export interface AttributeDetails {
|
|
|
902
912
|
*/
|
|
903
913
|
Attributes: AttributeItem[] | undefined;
|
|
904
914
|
/**
|
|
905
|
-
* <p>Mathematical expression that is performed on attribute items provided in the attribute
|
|
915
|
+
* <p>Mathematical expression that is performed on attribute items provided in the attribute
|
|
916
|
+
* list. Each element in the expression should follow the structure of
|
|
917
|
+
* \"\{ObjectTypeName.AttributeName\}\".</p>
|
|
906
918
|
* @public
|
|
907
919
|
*/
|
|
908
920
|
Expression: string | undefined;
|
|
@@ -969,8 +981,8 @@ export type AttributeMatchingModel = (typeof AttributeMatchingModel)[keyof typeo
|
|
|
969
981
|
*/
|
|
970
982
|
export interface AttributeTypesSelector {
|
|
971
983
|
/**
|
|
972
|
-
* <p>Configures the <code>AttributeMatchingModel</code>, you can either choose
|
|
973
|
-
*
|
|
984
|
+
* <p>Configures the <code>AttributeMatchingModel</code>, you can either choose
|
|
985
|
+
* <code>ONE_TO_ONE</code> or <code>MANY_TO_MANY</code>.</p>
|
|
974
986
|
* @public
|
|
975
987
|
*/
|
|
976
988
|
AttributeMatchingModel: AttributeMatchingModel | undefined;
|
|
@@ -1089,8 +1101,8 @@ export interface AutoMerging {
|
|
|
1089
1101
|
ConflictResolution?: ConflictResolution;
|
|
1090
1102
|
/**
|
|
1091
1103
|
* <p>A number between 0 and 1 that represents the minimum confidence score required for
|
|
1092
|
-
* profiles within a matching group to be merged during the auto-merge process. A higher
|
|
1093
|
-
*
|
|
1104
|
+
* profiles within a matching group to be merged during the auto-merge process. A higher score
|
|
1105
|
+
* means higher similarity required to merge profiles. </p>
|
|
1094
1106
|
* @public
|
|
1095
1107
|
*/
|
|
1096
1108
|
MinAllowedConfidenceScoreForMerging?: number;
|
|
@@ -1121,7 +1133,8 @@ export interface ListCalculatedAttributeDefinitionItem {
|
|
|
1121
1133
|
*/
|
|
1122
1134
|
CreatedAt?: Date;
|
|
1123
1135
|
/**
|
|
1124
|
-
* <p>The timestamp of when the calculated attribute definition was most recently
|
|
1136
|
+
* <p>The timestamp of when the calculated attribute definition was most recently
|
|
1137
|
+
* edited.</p>
|
|
1125
1138
|
* @public
|
|
1126
1139
|
*/
|
|
1127
1140
|
LastUpdatedAt?: Date;
|
|
@@ -1147,7 +1160,8 @@ export interface ListCalculatedAttributeForProfileItem {
|
|
|
1147
1160
|
*/
|
|
1148
1161
|
DisplayName?: string;
|
|
1149
1162
|
/**
|
|
1150
|
-
* <p>Indicates whether the calculated attribute’s value is based on partial data. If data is
|
|
1163
|
+
* <p>Indicates whether the calculated attribute’s value is based on partial data. If data is
|
|
1164
|
+
* partial, it is set to true.</p>
|
|
1151
1165
|
* @public
|
|
1152
1166
|
*/
|
|
1153
1167
|
IsDataPartial?: string;
|
|
@@ -1215,7 +1229,8 @@ export interface Threshold {
|
|
|
1215
1229
|
Operator: Operator | undefined;
|
|
1216
1230
|
}
|
|
1217
1231
|
/**
|
|
1218
|
-
* <p>The conditions including range, object count, and threshold for the calculated
|
|
1232
|
+
* <p>The conditions including range, object count, and threshold for the calculated
|
|
1233
|
+
* attribute.</p>
|
|
1219
1234
|
* @public
|
|
1220
1235
|
*/
|
|
1221
1236
|
export interface Conditions {
|
|
@@ -1278,12 +1293,14 @@ export interface CreateCalculatedAttributeDefinitionRequest {
|
|
|
1278
1293
|
*/
|
|
1279
1294
|
Description?: string;
|
|
1280
1295
|
/**
|
|
1281
|
-
* <p>Mathematical expression and a list of attribute items specified in that
|
|
1296
|
+
* <p>Mathematical expression and a list of attribute items specified in that
|
|
1297
|
+
* expression.</p>
|
|
1282
1298
|
* @public
|
|
1283
1299
|
*/
|
|
1284
1300
|
AttributeDetails: AttributeDetails | undefined;
|
|
1285
1301
|
/**
|
|
1286
|
-
* <p>The conditions including range, object count, and threshold for the calculated
|
|
1302
|
+
* <p>The conditions including range, object count, and threshold for the calculated
|
|
1303
|
+
* attribute.</p>
|
|
1287
1304
|
* @public
|
|
1288
1305
|
*/
|
|
1289
1306
|
Conditions?: Conditions;
|
|
@@ -1318,12 +1335,14 @@ export interface CreateCalculatedAttributeDefinitionResponse {
|
|
|
1318
1335
|
*/
|
|
1319
1336
|
Description?: string;
|
|
1320
1337
|
/**
|
|
1321
|
-
* <p>Mathematical expression and a list of attribute items specified in that
|
|
1338
|
+
* <p>Mathematical expression and a list of attribute items specified in that
|
|
1339
|
+
* expression.</p>
|
|
1322
1340
|
* @public
|
|
1323
1341
|
*/
|
|
1324
1342
|
AttributeDetails?: AttributeDetails;
|
|
1325
1343
|
/**
|
|
1326
|
-
* <p>The conditions including range, object count, and threshold for the calculated
|
|
1344
|
+
* <p>The conditions including range, object count, and threshold for the calculated
|
|
1345
|
+
* attribute.</p>
|
|
1327
1346
|
* @public
|
|
1328
1347
|
*/
|
|
1329
1348
|
Conditions?: Conditions;
|
|
@@ -1338,7 +1357,8 @@ export interface CreateCalculatedAttributeDefinitionResponse {
|
|
|
1338
1357
|
*/
|
|
1339
1358
|
CreatedAt?: Date;
|
|
1340
1359
|
/**
|
|
1341
|
-
* <p>The timestamp of when the calculated attribute definition was most recently
|
|
1360
|
+
* <p>The timestamp of when the calculated attribute definition was most recently
|
|
1361
|
+
* edited.</p>
|
|
1342
1362
|
* @public
|
|
1343
1363
|
*/
|
|
1344
1364
|
LastUpdatedAt?: Date;
|
|
@@ -1493,7 +1513,8 @@ export interface MatchingRequest {
|
|
|
1493
1513
|
* <p>PhoneNumber</p>
|
|
1494
1514
|
* </li>
|
|
1495
1515
|
* <li>
|
|
1496
|
-
* <p>Any customized profile attributes that start with the
|
|
1516
|
+
* <p>Any customized profile attributes that start with the
|
|
1517
|
+
* <code>Attributes</code>
|
|
1497
1518
|
* </p>
|
|
1498
1519
|
* </li>
|
|
1499
1520
|
* </ul>
|
|
@@ -1518,8 +1539,8 @@ export interface RuleBasedMatchingRequest {
|
|
|
1518
1539
|
*/
|
|
1519
1540
|
Enabled: boolean | undefined;
|
|
1520
1541
|
/**
|
|
1521
|
-
* <p>Configures how the rule-based matching process should match profiles. You can have up to
|
|
1522
|
-
* <code>MatchingRule</code> in the <code>MatchingRules</code>.</p>
|
|
1542
|
+
* <p>Configures how the rule-based matching process should match profiles. You can have up to
|
|
1543
|
+
* 15 <code>MatchingRule</code> in the <code>MatchingRules</code>.</p>
|
|
1523
1544
|
* @public
|
|
1524
1545
|
*/
|
|
1525
1546
|
MatchingRules?: MatchingRule[];
|
|
@@ -1598,11 +1619,13 @@ export interface CreateDomainRequest {
|
|
|
1598
1619
|
*/
|
|
1599
1620
|
Matching?: MatchingRequest;
|
|
1600
1621
|
/**
|
|
1601
|
-
* <p>The process of matching duplicate profiles using the Rule-Based matching. If
|
|
1602
|
-
*
|
|
1603
|
-
*
|
|
1604
|
-
*
|
|
1605
|
-
*
|
|
1622
|
+
* <p>The process of matching duplicate profiles using the Rule-Based matching. If
|
|
1623
|
+
* <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start
|
|
1624
|
+
* to match and merge your profiles according to your configuration in the
|
|
1625
|
+
* <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code>
|
|
1626
|
+
* and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have
|
|
1627
|
+
* configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you
|
|
1628
|
+
* can download the results from S3.</p>
|
|
1606
1629
|
* @public
|
|
1607
1630
|
*/
|
|
1608
1631
|
RuleBasedMatching?: RuleBasedMatchingRequest;
|
|
@@ -1663,8 +1686,8 @@ export interface RuleBasedMatchingResponse {
|
|
|
1663
1686
|
*/
|
|
1664
1687
|
Enabled?: boolean;
|
|
1665
1688
|
/**
|
|
1666
|
-
* <p>Configures how the rule-based matching process should match profiles. You can have up to
|
|
1667
|
-
* <code>MatchingRule</code> in the <code>MatchingRules</code>.</p>
|
|
1689
|
+
* <p>Configures how the rule-based matching process should match profiles. You can have up to
|
|
1690
|
+
* 15 <code>MatchingRule</code> in the <code>MatchingRules</code>.</p>
|
|
1668
1691
|
* @public
|
|
1669
1692
|
*/
|
|
1670
1693
|
MatchingRules?: MatchingRule[];
|
|
@@ -1769,11 +1792,13 @@ export interface CreateDomainResponse {
|
|
|
1769
1792
|
*/
|
|
1770
1793
|
Matching?: MatchingResponse;
|
|
1771
1794
|
/**
|
|
1772
|
-
* <p>The process of matching duplicate profiles using the Rule-Based matching. If
|
|
1773
|
-
*
|
|
1774
|
-
*
|
|
1775
|
-
*
|
|
1776
|
-
*
|
|
1795
|
+
* <p>The process of matching duplicate profiles using the Rule-Based matching. If
|
|
1796
|
+
* <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start
|
|
1797
|
+
* to match and merge your profiles according to your configuration in the
|
|
1798
|
+
* <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code>
|
|
1799
|
+
* and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have
|
|
1800
|
+
* configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you
|
|
1801
|
+
* can download the results from S3.</p>
|
|
1777
1802
|
* @public
|
|
1778
1803
|
*/
|
|
1779
1804
|
RuleBasedMatching?: RuleBasedMatchingResponse;
|
|
@@ -1942,7 +1967,7 @@ export interface CreateProfileRequest {
|
|
|
1942
1967
|
*/
|
|
1943
1968
|
DomainName: string | undefined;
|
|
1944
1969
|
/**
|
|
1945
|
-
* <p>
|
|
1970
|
+
* <p>An account number that you have given to the customer.</p>
|
|
1946
1971
|
* @public
|
|
1947
1972
|
*/
|
|
1948
1973
|
AccountNumber?: string;
|
|
@@ -2378,13 +2403,14 @@ export type StandardIdentifier = (typeof StandardIdentifier)[keyof typeof Standa
|
|
|
2378
2403
|
export interface ObjectTypeKey {
|
|
2379
2404
|
/**
|
|
2380
2405
|
* <p>The types of keys that a ProfileObject can have. Each ProfileObject can have only 1
|
|
2381
|
-
* UNIQUE key but multiple PROFILE keys. PROFILE, ASSET, CASE, or ORDER
|
|
2382
|
-
* used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. UNIQUE means
|
|
2383
|
-
* used to uniquely identify an object. If a key a is marked as SECONDARY, it
|
|
2384
|
-
* search for profiles after all other PROFILE keys have been searched. A
|
|
2385
|
-
* only used to match a profile but is not persisted to be used for
|
|
2386
|
-
* A NEW_ONLY key is only used if the profile does not already exist
|
|
2387
|
-
* ingested, otherwise it is only used for matching objects to
|
|
2406
|
+
* UNIQUE key but multiple PROFILE keys. PROFILE, ASSET, CASE, or ORDER means that this key
|
|
2407
|
+
* can be used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. UNIQUE means
|
|
2408
|
+
* that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it
|
|
2409
|
+
* will be used to search for profiles after all other PROFILE keys have been searched. A
|
|
2410
|
+
* LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for
|
|
2411
|
+
* searching of the profile. A NEW_ONLY key is only used if the profile does not already exist
|
|
2412
|
+
* before the object is ingested, otherwise it is only used for matching objects to
|
|
2413
|
+
* profiles.</p>
|
|
2388
2414
|
* @public
|
|
2389
2415
|
*/
|
|
2390
2416
|
StandardIdentifiers?: StandardIdentifier[];
|
|
@@ -2400,7 +2426,8 @@ export interface ObjectTypeKey {
|
|
|
2400
2426
|
*/
|
|
2401
2427
|
export interface DetectedProfileObjectType {
|
|
2402
2428
|
/**
|
|
2403
|
-
* <p>The format of <code>sourceLastUpdatedTimestamp</code> that was detected in
|
|
2429
|
+
* <p>The format of <code>sourceLastUpdatedTimestamp</code> that was detected in
|
|
2430
|
+
* fields.</p>
|
|
2404
2431
|
* @public
|
|
2405
2432
|
*/
|
|
2406
2433
|
SourceLastUpdatedTimestampFormat?: string;
|
|
@@ -2420,7 +2447,8 @@ export interface DetectedProfileObjectType {
|
|
|
2420
2447
|
*/
|
|
2421
2448
|
export interface DetectProfileObjectTypeResponse {
|
|
2422
2449
|
/**
|
|
2423
|
-
* <p>Detected <code>ProfileObjectType</code> mappings from given objects. A maximum of one
|
|
2450
|
+
* <p>Detected <code>ProfileObjectType</code> mappings from given objects. A maximum of one
|
|
2451
|
+
* mapping is supported.</p>
|
|
2424
2452
|
* @public
|
|
2425
2453
|
*/
|
|
2426
2454
|
DetectedProfileObjectTypes?: DetectedProfileObjectType[];
|
|
@@ -2445,7 +2473,8 @@ export interface GetAutoMergingPreviewRequest {
|
|
|
2445
2473
|
*/
|
|
2446
2474
|
ConflictResolution: ConflictResolution | undefined;
|
|
2447
2475
|
/**
|
|
2448
|
-
* <p>Minimum confidence score required for profiles within a matching group to be merged
|
|
2476
|
+
* <p>Minimum confidence score required for profiles within a matching group to be merged
|
|
2477
|
+
* during the auto-merge process.</p>
|
|
2449
2478
|
* @public
|
|
2450
2479
|
*/
|
|
2451
2480
|
MinAllowedConfidenceScoreForMerging?: number;
|
|
@@ -2516,7 +2545,8 @@ export interface GetCalculatedAttributeDefinitionResponse {
|
|
|
2516
2545
|
*/
|
|
2517
2546
|
CreatedAt?: Date;
|
|
2518
2547
|
/**
|
|
2519
|
-
* <p>The timestamp of when the calculated attribute definition was most recently
|
|
2548
|
+
* <p>The timestamp of when the calculated attribute definition was most recently
|
|
2549
|
+
* edited.</p>
|
|
2520
2550
|
* @public
|
|
2521
2551
|
*/
|
|
2522
2552
|
LastUpdatedAt?: Date;
|
|
@@ -2526,12 +2556,14 @@ export interface GetCalculatedAttributeDefinitionResponse {
|
|
|
2526
2556
|
*/
|
|
2527
2557
|
Statistic?: Statistic;
|
|
2528
2558
|
/**
|
|
2529
|
-
* <p>The conditions including range, object count, and threshold for the calculated
|
|
2559
|
+
* <p>The conditions including range, object count, and threshold for the calculated
|
|
2560
|
+
* attribute.</p>
|
|
2530
2561
|
* @public
|
|
2531
2562
|
*/
|
|
2532
2563
|
Conditions?: Conditions;
|
|
2533
2564
|
/**
|
|
2534
|
-
* <p>Mathematical expression and a list of attribute items specified in that
|
|
2565
|
+
* <p>Mathematical expression and a list of attribute items specified in that
|
|
2566
|
+
* expression.</p>
|
|
2535
2567
|
* @public
|
|
2536
2568
|
*/
|
|
2537
2569
|
AttributeDetails?: AttributeDetails;
|
|
@@ -2576,7 +2608,8 @@ export interface GetCalculatedAttributeForProfileResponse {
|
|
|
2576
2608
|
*/
|
|
2577
2609
|
DisplayName?: string;
|
|
2578
2610
|
/**
|
|
2579
|
-
* <p>Indicates whether the calculated attribute’s value is based on partial data. If data is
|
|
2611
|
+
* <p>Indicates whether the calculated attribute’s value is based on partial data. If data is
|
|
2612
|
+
* partial, it is set to true.</p>
|
|
2580
2613
|
* @public
|
|
2581
2614
|
*/
|
|
2582
2615
|
IsDataPartial?: string;
|
|
@@ -2668,11 +2701,13 @@ export interface GetDomainResponse {
|
|
|
2668
2701
|
*/
|
|
2669
2702
|
Matching?: MatchingResponse;
|
|
2670
2703
|
/**
|
|
2671
|
-
* <p>The process of matching duplicate profiles using the Rule-Based matching. If
|
|
2672
|
-
*
|
|
2673
|
-
*
|
|
2674
|
-
*
|
|
2675
|
-
*
|
|
2704
|
+
* <p>The process of matching duplicate profiles using the Rule-Based matching. If
|
|
2705
|
+
* <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start
|
|
2706
|
+
* to match and merge your profiles according to your configuration in the
|
|
2707
|
+
* <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code>
|
|
2708
|
+
* and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have
|
|
2709
|
+
* configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you
|
|
2710
|
+
* can download the results from S3.</p>
|
|
2676
2711
|
* @public
|
|
2677
2712
|
*/
|
|
2678
2713
|
RuleBasedMatching?: RuleBasedMatchingResponse;
|
|
@@ -2741,7 +2776,8 @@ export interface EventStreamDestinationDetails {
|
|
|
2741
2776
|
*/
|
|
2742
2777
|
UnhealthySince?: Date;
|
|
2743
2778
|
/**
|
|
2744
|
-
* <p>The human-readable string that corresponds to the error or success while enabling the
|
|
2779
|
+
* <p>The human-readable string that corresponds to the error or success while enabling the
|
|
2780
|
+
* streaming destination.</p>
|
|
2745
2781
|
* @public
|
|
2746
2782
|
*/
|
|
2747
2783
|
Message?: string;
|
|
@@ -3035,8 +3071,9 @@ export interface GetIntegrationResponse {
|
|
|
3035
3071
|
*/
|
|
3036
3072
|
WorkflowId?: string;
|
|
3037
3073
|
/**
|
|
3038
|
-
* <p>Boolean that shows if the Flow that's associated with the Integration is created in
|
|
3039
|
-
* Appflow, or with ObjectTypeName equals _unstructured via API/CLI in
|
|
3074
|
+
* <p>Boolean that shows if the Flow that's associated with the Integration is created in
|
|
3075
|
+
* Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in
|
|
3076
|
+
* flowDefinition.</p>
|
|
3040
3077
|
* @public
|
|
3041
3078
|
*/
|
|
3042
3079
|
IsUnstructured?: boolean;
|
|
@@ -3078,13 +3115,13 @@ export interface MatchItem {
|
|
|
3078
3115
|
*/
|
|
3079
3116
|
ProfileIds?: string[];
|
|
3080
3117
|
/**
|
|
3081
|
-
* <p>A number between 0 and 1, where a higher score means higher similarity.
|
|
3082
|
-
*
|
|
3083
|
-
*
|
|
3084
|
-
* which the system is uncertain (which you may decide to have reviewed by a human),
|
|
3085
|
-
*
|
|
3086
|
-
* Given confidence scores vary as per the data input, it should not be used an
|
|
3087
|
-
* measure of matching quality.</p>
|
|
3118
|
+
* <p>A number between 0 and 1, where a higher score means higher similarity. Examining match
|
|
3119
|
+
* confidence scores lets you distinguish between groups of similar records in which the
|
|
3120
|
+
* system is highly confident (which you may decide to merge), groups of similar records about
|
|
3121
|
+
* which the system is uncertain (which you may decide to have reviewed by a human), and
|
|
3122
|
+
* groups of similar records that the system deems to be unlikely (which you may decide to
|
|
3123
|
+
* reject). Given confidence scores vary as per the data input, it should not be used an
|
|
3124
|
+
* absolute measure of matching quality.</p>
|
|
3088
3125
|
* @public
|
|
3089
3126
|
*/
|
|
3090
3127
|
ConfidenceScore?: number;
|
|
@@ -3174,6 +3211,16 @@ export interface GetProfileObjectTypeResponse {
|
|
|
3174
3211
|
* @public
|
|
3175
3212
|
*/
|
|
3176
3213
|
SourceLastUpdatedTimestampFormat?: string;
|
|
3214
|
+
/**
|
|
3215
|
+
* <p>The amount of provisioned profile object max count available.</p>
|
|
3216
|
+
* @public
|
|
3217
|
+
*/
|
|
3218
|
+
MaxAvailableProfileObjectCount?: number;
|
|
3219
|
+
/**
|
|
3220
|
+
* <p>The amount of profile object max count assigned to the object type.</p>
|
|
3221
|
+
* @public
|
|
3222
|
+
*/
|
|
3223
|
+
MaxProfileObjectCount?: number;
|
|
3177
3224
|
/**
|
|
3178
3225
|
* <p>A map of the name and ObjectType field.</p>
|
|
3179
3226
|
* @public
|
|
@@ -3561,8 +3608,9 @@ export interface ListIntegrationItem {
|
|
|
3561
3608
|
*/
|
|
3562
3609
|
WorkflowId?: string;
|
|
3563
3610
|
/**
|
|
3564
|
-
* <p>Boolean that shows if the Flow that's associated with the Integration is created in
|
|
3565
|
-
* Appflow, or with ObjectTypeName equals _unstructured via API/CLI in
|
|
3611
|
+
* <p>Boolean that shows if the Flow that's associated with the Integration is created in
|
|
3612
|
+
* Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in
|
|
3613
|
+
* flowDefinition.</p>
|
|
3566
3614
|
* @public
|
|
3567
3615
|
*/
|
|
3568
3616
|
IsUnstructured?: boolean;
|
|
@@ -3592,7 +3640,8 @@ export interface ListCalculatedAttributeDefinitionsRequest {
|
|
|
3592
3640
|
*/
|
|
3593
3641
|
DomainName: string | undefined;
|
|
3594
3642
|
/**
|
|
3595
|
-
* <p>The pagination token from the previous call to
|
|
3643
|
+
* <p>The pagination token from the previous call to
|
|
3644
|
+
* ListCalculatedAttributeDefinitions.</p>
|
|
3596
3645
|
* @public
|
|
3597
3646
|
*/
|
|
3598
3647
|
NextToken?: string;
|
|
@@ -3612,7 +3661,8 @@ export interface ListCalculatedAttributeDefinitionsResponse {
|
|
|
3612
3661
|
*/
|
|
3613
3662
|
Items?: ListCalculatedAttributeDefinitionItem[];
|
|
3614
3663
|
/**
|
|
3615
|
-
* <p>The pagination token from the previous call to
|
|
3664
|
+
* <p>The pagination token from the previous call to
|
|
3665
|
+
* ListCalculatedAttributeDefinitions.</p>
|
|
3616
3666
|
* @public
|
|
3617
3667
|
*/
|
|
3618
3668
|
NextToken?: string;
|
|
@@ -3622,7 +3672,8 @@ export interface ListCalculatedAttributeDefinitionsResponse {
|
|
|
3622
3672
|
*/
|
|
3623
3673
|
export interface ListCalculatedAttributesForProfileRequest {
|
|
3624
3674
|
/**
|
|
3625
|
-
* <p>The pagination token from the previous call to
|
|
3675
|
+
* <p>The pagination token from the previous call to
|
|
3676
|
+
* ListCalculatedAttributesForProfile.</p>
|
|
3626
3677
|
* @public
|
|
3627
3678
|
*/
|
|
3628
3679
|
NextToken?: string;
|
|
@@ -3652,7 +3703,8 @@ export interface ListCalculatedAttributesForProfileResponse {
|
|
|
3652
3703
|
*/
|
|
3653
3704
|
Items?: ListCalculatedAttributeForProfileItem[];
|
|
3654
3705
|
/**
|
|
3655
|
-
* <p>The pagination token from the previous call to
|
|
3706
|
+
* <p>The pagination token from the previous call to
|
|
3707
|
+
* ListCalculatedAttributesForProfile.</p>
|
|
3656
3708
|
* @public
|
|
3657
3709
|
*/
|
|
3658
3710
|
NextToken?: string;
|
|
@@ -3969,17 +4021,17 @@ export interface ListIntegrationsResponse {
|
|
|
3969
4021
|
NextToken?: string;
|
|
3970
4022
|
}
|
|
3971
4023
|
/**
|
|
3972
|
-
* <p>The filter applied to <code>ListProfileObjects</code> response to include profile
|
|
3973
|
-
* specified index values.</p>
|
|
4024
|
+
* <p>The filter applied to <code>ListProfileObjects</code> response to include profile
|
|
4025
|
+
* objects with the specified index values.</p>
|
|
3974
4026
|
* @public
|
|
3975
4027
|
*/
|
|
3976
4028
|
export interface ObjectFilter {
|
|
3977
4029
|
/**
|
|
3978
|
-
* <p>A searchable identifier of a profile object. The predefined keys you can use to
|
|
3979
|
-
*
|
|
3980
|
-
*
|
|
3981
|
-
*
|
|
3982
|
-
* <code>_order</code> include: <code>_orderId</code>.</p>
|
|
4030
|
+
* <p>A searchable identifier of a profile object. The predefined keys you can use to search
|
|
4031
|
+
* for <code>_asset</code> include: <code>_assetId</code>, <code>_assetName</code>, and
|
|
4032
|
+
* <code>_serialNumber</code>. The predefined keys you can use to search for
|
|
4033
|
+
* <code>_case</code> include: <code>_caseId</code>. The predefined keys you can use to
|
|
4034
|
+
* search for <code>_order</code> include: <code>_orderId</code>.</p>
|
|
3983
4035
|
* @public
|
|
3984
4036
|
*/
|
|
3985
4037
|
KeyName: string | undefined;
|
|
@@ -4107,6 +4159,16 @@ export interface ListProfileObjectTypeItem {
|
|
|
4107
4159
|
* @public
|
|
4108
4160
|
*/
|
|
4109
4161
|
LastUpdatedAt?: Date;
|
|
4162
|
+
/**
|
|
4163
|
+
* <p>The amount of profile object max count assigned to the object type.</p>
|
|
4164
|
+
* @public
|
|
4165
|
+
*/
|
|
4166
|
+
MaxProfileObjectCount?: number;
|
|
4167
|
+
/**
|
|
4168
|
+
* <p>The amount of provisioned profile object max count available.</p>
|
|
4169
|
+
* @public
|
|
4170
|
+
*/
|
|
4171
|
+
MaxAvailableProfileObjectCount?: number;
|
|
4110
4172
|
/**
|
|
4111
4173
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
4112
4174
|
* @public
|
|
@@ -4561,8 +4623,9 @@ export interface PutIntegrationResponse {
|
|
|
4561
4623
|
*/
|
|
4562
4624
|
WorkflowId?: string;
|
|
4563
4625
|
/**
|
|
4564
|
-
* <p>Boolean that shows if the Flow that's associated with the Integration is created in
|
|
4565
|
-
* Appflow, or with ObjectTypeName equals _unstructured via API/CLI in
|
|
4626
|
+
* <p>Boolean that shows if the Flow that's associated with the Integration is created in
|
|
4627
|
+
* Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in
|
|
4628
|
+
* flowDefinition.</p>
|
|
4566
4629
|
* @public
|
|
4567
4630
|
*/
|
|
4568
4631
|
IsUnstructured?: boolean;
|
|
@@ -4619,10 +4682,11 @@ export interface PutProfileObjectTypeRequest {
|
|
|
4619
4682
|
/**
|
|
4620
4683
|
* <p>A unique identifier for the object template. For some attributes in the request, the
|
|
4621
4684
|
* service will use the default value from the object template when TemplateId is present. If
|
|
4622
|
-
* these attributes are present in the request, the service may return a
|
|
4623
|
-
*
|
|
4624
|
-
* Fields, and Keys. For example, if AllowProfileCreation is
|
|
4625
|
-
* may return a
|
|
4685
|
+
* these attributes are present in the request, the service may return a
|
|
4686
|
+
* <code>BadRequestException</code>. These attributes include: AllowProfileCreation,
|
|
4687
|
+
* SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is
|
|
4688
|
+
* set to true when TemplateId is set, the service may return a
|
|
4689
|
+
* <code>BadRequestException</code>.</p>
|
|
4626
4690
|
* @public
|
|
4627
4691
|
*/
|
|
4628
4692
|
TemplateId?: string;
|
|
@@ -4652,6 +4716,11 @@ export interface PutProfileObjectTypeRequest {
|
|
|
4652
4716
|
* @public
|
|
4653
4717
|
*/
|
|
4654
4718
|
SourceLastUpdatedTimestampFormat?: string;
|
|
4719
|
+
/**
|
|
4720
|
+
* <p>The amount of profile object max count assigned to the object type</p>
|
|
4721
|
+
* @public
|
|
4722
|
+
*/
|
|
4723
|
+
MaxProfileObjectCount?: number;
|
|
4655
4724
|
/**
|
|
4656
4725
|
* <p>A map of the name and ObjectType field.</p>
|
|
4657
4726
|
* @public
|
|
@@ -4714,6 +4783,16 @@ export interface PutProfileObjectTypeResponse {
|
|
|
4714
4783
|
* @public
|
|
4715
4784
|
*/
|
|
4716
4785
|
SourceLastUpdatedTimestampFormat?: string;
|
|
4786
|
+
/**
|
|
4787
|
+
* <p>The amount of profile object max count assigned to the object type.</p>
|
|
4788
|
+
* @public
|
|
4789
|
+
*/
|
|
4790
|
+
MaxProfileObjectCount?: number;
|
|
4791
|
+
/**
|
|
4792
|
+
* <p>The amount of provisioned profile object max count available.</p>
|
|
4793
|
+
* @public
|
|
4794
|
+
*/
|
|
4795
|
+
MaxAvailableProfileObjectCount?: number;
|
|
4717
4796
|
/**
|
|
4718
4797
|
* <p>A map of the name and ObjectType field.</p>
|
|
4719
4798
|
* @public
|
|
@@ -4773,12 +4852,11 @@ export interface SearchProfilesRequest {
|
|
|
4773
4852
|
*/
|
|
4774
4853
|
DomainName: string | undefined;
|
|
4775
4854
|
/**
|
|
4776
|
-
* <p>A searchable identifier of a customer profile. The predefined keys you can use
|
|
4777
|
-
*
|
|
4778
|
-
*
|
|
4779
|
-
*
|
|
4780
|
-
*
|
|
4781
|
-
* _shopifyOrderId.</p>
|
|
4855
|
+
* <p>A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId,
|
|
4856
|
+
* _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId,
|
|
4857
|
+
* _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId,
|
|
4858
|
+
* _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId,
|
|
4859
|
+
* _segmentUserId, _shopifyCustomerId, _shopifyOrderId.</p>
|
|
4782
4860
|
* @public
|
|
4783
4861
|
*/
|
|
4784
4862
|
KeyName: string | undefined;
|
|
@@ -4788,38 +4866,44 @@ export interface SearchProfilesRequest {
|
|
|
4788
4866
|
*/
|
|
4789
4867
|
Values: string[] | undefined;
|
|
4790
4868
|
/**
|
|
4791
|
-
* <p>A list of <code>AdditionalSearchKey</code> objects that are each searchable identifiers
|
|
4792
|
-
* profile. Each <code>AdditionalSearchKey</code> object contains a <code>KeyName</code>
|
|
4793
|
-
* list of <code>Values</code> associated with that specific key (i.e., a key-value(s)
|
|
4794
|
-
* These additional search keys will be used in conjunction with the
|
|
4795
|
-
*
|
|
4796
|
-
*
|
|
4869
|
+
* <p>A list of <code>AdditionalSearchKey</code> objects that are each searchable identifiers
|
|
4870
|
+
* of a profile. Each <code>AdditionalSearchKey</code> object contains a <code>KeyName</code>
|
|
4871
|
+
* and a list of <code>Values</code> associated with that specific key (i.e., a key-value(s)
|
|
4872
|
+
* pair). These additional search keys will be used in conjunction with the
|
|
4873
|
+
* <code>LogicalOperator</code> and the required <code>KeyName</code> and
|
|
4874
|
+
* <code>Values</code> parameters to search for profiles that satisfy the search criteria.
|
|
4875
|
+
* </p>
|
|
4797
4876
|
* @public
|
|
4798
4877
|
*/
|
|
4799
4878
|
AdditionalSearchKeys?: AdditionalSearchKey[];
|
|
4800
4879
|
/**
|
|
4801
|
-
* <p>Relationship between all specified search keys that will be used to search for
|
|
4802
|
-
*
|
|
4803
|
-
* as
|
|
4804
|
-
* <p>This parameter influences which profiles will be returned in the response in the
|
|
4880
|
+
* <p>Relationship between all specified search keys that will be used to search for profiles.
|
|
4881
|
+
* This includes the required <code>KeyName</code> and <code>Values</code> parameters as well
|
|
4882
|
+
* as any key-value(s) pairs specified in the <code>AdditionalSearchKeys</code> list.</p>
|
|
4883
|
+
* <p>This parameter influences which profiles will be returned in the response in the
|
|
4884
|
+
* following manner:</p>
|
|
4805
4885
|
* <ul>
|
|
4806
4886
|
* <li>
|
|
4807
4887
|
* <p>
|
|
4808
|
-
* <code>AND</code> - The response only includes profiles that match all of the
|
|
4888
|
+
* <code>AND</code> - The response only includes profiles that match all of the
|
|
4889
|
+
* search keys.</p>
|
|
4809
4890
|
* </li>
|
|
4810
4891
|
* <li>
|
|
4811
4892
|
* <p>
|
|
4812
|
-
* <code>OR</code> - The response includes profiles that match at least one of the
|
|
4893
|
+
* <code>OR</code> - The response includes profiles that match at least one of the
|
|
4894
|
+
* search keys.</p>
|
|
4813
4895
|
* </li>
|
|
4814
4896
|
* </ul>
|
|
4815
|
-
* <p>The <code>OR</code> relationship is the default behavior if this parameter is not
|
|
4897
|
+
* <p>The <code>OR</code> relationship is the default behavior if this parameter is not
|
|
4898
|
+
* included in the request.</p>
|
|
4816
4899
|
* @public
|
|
4817
4900
|
*/
|
|
4818
4901
|
LogicalOperator?: LogicalOperator;
|
|
4819
4902
|
}
|
|
4820
4903
|
/**
|
|
4821
|
-
* <p>A data type pair that consists of a <code>KeyName</code> and <code>Values</code> list
|
|
4822
|
-
* to find a profile returned in response to a <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a> request.
|
|
4904
|
+
* <p>A data type pair that consists of a <code>KeyName</code> and <code>Values</code> list
|
|
4905
|
+
* that were used to find a profile returned in response to a <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a> request.
|
|
4906
|
+
* </p>
|
|
4823
4907
|
* @public
|
|
4824
4908
|
*/
|
|
4825
4909
|
export interface FoundByKeyValue {
|
|
@@ -4845,7 +4929,7 @@ export interface Profile {
|
|
|
4845
4929
|
*/
|
|
4846
4930
|
ProfileId?: string;
|
|
4847
4931
|
/**
|
|
4848
|
-
* <p>
|
|
4932
|
+
* <p>An account number that you have given to the customer.</p>
|
|
4849
4933
|
* @public
|
|
4850
4934
|
*/
|
|
4851
4935
|
AccountNumber?: string;
|
|
@@ -4960,24 +5044,26 @@ export interface Profile {
|
|
|
4960
5044
|
* <p>A list of items used to find a profile returned in a <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a> response.
|
|
4961
5045
|
* An item is a key-value(s) pair that matches an attribute in the profile.</p>
|
|
4962
5046
|
* <p>If the optional <code>AdditionalSearchKeys</code> parameter was included in the
|
|
4963
|
-
* <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a> request, the <code>FoundByItems</code> list should be
|
|
4964
|
-
*
|
|
5047
|
+
* <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a> request, the <code>FoundByItems</code> list should be interpreted
|
|
5048
|
+
* based on the <code>LogicalOperator</code> used in the request:</p>
|
|
4965
5049
|
* <ul>
|
|
4966
5050
|
* <li>
|
|
4967
5051
|
* <p>
|
|
4968
|
-
* <code>AND</code> - The profile included in the response matched all of the search
|
|
4969
|
-
*
|
|
4970
|
-
*
|
|
5052
|
+
* <code>AND</code> - The profile included in the response matched all of the search
|
|
5053
|
+
* keys specified in the request. The <code>FoundByItems</code> will include all of the
|
|
5054
|
+
* key-value(s) pairs that were specified in the request (as this is a requirement of
|
|
5055
|
+
* <code>AND</code> search logic).</p>
|
|
4971
5056
|
* </li>
|
|
4972
5057
|
* <li>
|
|
4973
5058
|
* <p>
|
|
4974
5059
|
* <code>OR</code> - The profile included in the response matched at least one of the
|
|
4975
|
-
*
|
|
4976
|
-
*
|
|
5060
|
+
* search keys specified in the request. The <code>FoundByItems</code> will include each
|
|
5061
|
+
* of the key-value(s) pairs that the profile was found by.</p>
|
|
4977
5062
|
* </li>
|
|
4978
5063
|
* </ul>
|
|
4979
|
-
* <p>The <code>OR</code> relationship is the default behavior if the
|
|
4980
|
-
*
|
|
5064
|
+
* <p>The <code>OR</code> relationship is the default behavior if the
|
|
5065
|
+
* <code>LogicalOperator</code> parameter is not included in the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a>
|
|
5066
|
+
* request.</p>
|
|
4981
5067
|
* @public
|
|
4982
5068
|
*/
|
|
4983
5069
|
FoundByItems?: FoundByKeyValue[];
|
|
@@ -5072,7 +5158,8 @@ export interface UpdateCalculatedAttributeDefinitionRequest {
|
|
|
5072
5158
|
*/
|
|
5073
5159
|
Description?: string;
|
|
5074
5160
|
/**
|
|
5075
|
-
* <p>The conditions including range, object count, and threshold for the calculated
|
|
5161
|
+
* <p>The conditions including range, object count, and threshold for the calculated
|
|
5162
|
+
* attribute.</p>
|
|
5076
5163
|
* @public
|
|
5077
5164
|
*/
|
|
5078
5165
|
Conditions?: Conditions;
|
|
@@ -5102,7 +5189,8 @@ export interface UpdateCalculatedAttributeDefinitionResponse {
|
|
|
5102
5189
|
*/
|
|
5103
5190
|
CreatedAt?: Date;
|
|
5104
5191
|
/**
|
|
5105
|
-
* <p>The timestamp of when the calculated attribute definition was most recently
|
|
5192
|
+
* <p>The timestamp of when the calculated attribute definition was most recently
|
|
5193
|
+
* edited.</p>
|
|
5106
5194
|
* @public
|
|
5107
5195
|
*/
|
|
5108
5196
|
LastUpdatedAt?: Date;
|
|
@@ -5112,12 +5200,14 @@ export interface UpdateCalculatedAttributeDefinitionResponse {
|
|
|
5112
5200
|
*/
|
|
5113
5201
|
Statistic?: Statistic;
|
|
5114
5202
|
/**
|
|
5115
|
-
* <p>The conditions including range, object count, and threshold for the calculated
|
|
5203
|
+
* <p>The conditions including range, object count, and threshold for the calculated
|
|
5204
|
+
* attribute.</p>
|
|
5116
5205
|
* @public
|
|
5117
5206
|
*/
|
|
5118
5207
|
Conditions?: Conditions;
|
|
5119
5208
|
/**
|
|
5120
|
-
* <p>The mathematical expression and a list of attribute items specified in that
|
|
5209
|
+
* <p>The mathematical expression and a list of attribute items specified in that
|
|
5210
|
+
* expression.</p>
|
|
5121
5211
|
* @public
|
|
5122
5212
|
*/
|
|
5123
5213
|
AttributeDetails?: AttributeDetails;
|
|
@@ -5327,7 +5417,7 @@ export interface UpdateProfileRequest {
|
|
|
5327
5417
|
*/
|
|
5328
5418
|
AdditionalInformation?: string;
|
|
5329
5419
|
/**
|
|
5330
|
-
* <p>
|
|
5420
|
+
* <p>An account number that you have given to the customer.</p>
|
|
5331
5421
|
* @public
|
|
5332
5422
|
*/
|
|
5333
5423
|
AccountNumber?: string;
|
|
@@ -872,6 +872,8 @@ export interface GetProfileObjectTypeResponse {
|
|
|
872
872
|
EncryptionKey?: string;
|
|
873
873
|
AllowProfileCreation?: boolean;
|
|
874
874
|
SourceLastUpdatedTimestampFormat?: string;
|
|
875
|
+
MaxAvailableProfileObjectCount?: number;
|
|
876
|
+
MaxProfileObjectCount?: number;
|
|
875
877
|
Fields?: Record<string, ObjectTypeField>;
|
|
876
878
|
Keys?: Record<string, ObjectTypeKey[]>;
|
|
877
879
|
CreatedAt?: Date;
|
|
@@ -1083,6 +1085,8 @@ export interface ListProfileObjectTypeItem {
|
|
|
1083
1085
|
Description: string | undefined;
|
|
1084
1086
|
CreatedAt?: Date;
|
|
1085
1087
|
LastUpdatedAt?: Date;
|
|
1088
|
+
MaxProfileObjectCount?: number;
|
|
1089
|
+
MaxAvailableProfileObjectCount?: number;
|
|
1086
1090
|
Tags?: Record<string, string>;
|
|
1087
1091
|
}
|
|
1088
1092
|
export interface ListProfileObjectTypesResponse {
|
|
@@ -1206,6 +1210,7 @@ export interface PutProfileObjectTypeRequest {
|
|
|
1206
1210
|
EncryptionKey?: string;
|
|
1207
1211
|
AllowProfileCreation?: boolean;
|
|
1208
1212
|
SourceLastUpdatedTimestampFormat?: string;
|
|
1213
|
+
MaxProfileObjectCount?: number;
|
|
1209
1214
|
Fields?: Record<string, ObjectTypeField>;
|
|
1210
1215
|
Keys?: Record<string, ObjectTypeKey[]>;
|
|
1211
1216
|
Tags?: Record<string, string>;
|
|
@@ -1218,6 +1223,8 @@ export interface PutProfileObjectTypeResponse {
|
|
|
1218
1223
|
EncryptionKey?: string;
|
|
1219
1224
|
AllowProfileCreation?: boolean;
|
|
1220
1225
|
SourceLastUpdatedTimestampFormat?: string;
|
|
1226
|
+
MaxProfileObjectCount?: number;
|
|
1227
|
+
MaxAvailableProfileObjectCount?: number;
|
|
1221
1228
|
Fields?: Record<string, ObjectTypeField>;
|
|
1222
1229
|
Keys?: Record<string, ObjectTypeKey[]>;
|
|
1223
1230
|
CreatedAt?: Date;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-customer-profiles",
|
|
3
3
|
"description": "AWS SDK for JavaScript Customer Profiles Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.606.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-customer-profiles",
|
|
@@ -20,8 +20,8 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
23
|
-
"@aws-sdk/client-sso-oidc": "3.
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
23
|
+
"@aws-sdk/client-sso-oidc": "3.606.0",
|
|
24
|
+
"@aws-sdk/client-sts": "3.606.0",
|
|
25
25
|
"@aws-sdk/core": "3.598.0",
|
|
26
26
|
"@aws-sdk/credential-provider-node": "3.600.0",
|
|
27
27
|
"@aws-sdk/middleware-host-header": "3.598.0",
|