Skip to content

Commit a72bef5

Browse files
author
awstools
committed
feat(client-customer-profiles): This release includes changes to ProfileObjectType APIs, adds functionality top set and get capacity for profile object types.
1 parent 55c8f49 commit a72bef5

21 files changed

+451
-267
lines changed

‎clients/client-customer-profiles/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@ AWS SDK for JavaScript CustomerProfiles Client for Node.js, Browser and React Na
88

99
<fullname>Amazon Connect Customer Profiles</fullname>
1010

11-
<p>Amazon Connect Customer Profiles is a unified customer profile for your contact center that has
12-
pre-built connectors powered by AppFlow that make it easy to combine customer information
13-
from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your
14-
enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
15-
If you're new to Amazon Connect, you might find it helpful to review the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/">Amazon Connect Administrator Guide</a>.</p>
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>
1617

1718
## Installing
1819

‎clients/client-customer-profiles/src/CustomerProfiles.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1084,11 +1084,12 @@ export interface CustomerProfiles {
10841084

10851085
/**
10861086
* <fullname>Amazon Connect Customer Profiles</fullname>
1087-
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact center that has
1088-
* pre-built connectors powered by AppFlow that make it easy to combine customer information
1089-
* from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your
1090-
* enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
1091-
* If you're new to Amazon Connect, you might find it helpful to review the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/">Amazon Connect Administrator Guide</a>.</p>
1087+
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact
1088+
* center that has pre-built connectors powered by AppFlow that make it easy to combine
1089+
* customer information from third party applications, such as Salesforce (CRM), ServiceNow
1090+
* (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. </p>
1091+
* <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
1092+
* Profiles</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>
10921093
* @public
10931094
*/
10941095
export class CustomerProfiles extends CustomerProfilesClient implements CustomerProfiles {}

‎clients/client-customer-profiles/src/CustomerProfilesClient.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -469,11 +469,12 @@ export interface CustomerProfilesClientResolvedConfig extends CustomerProfilesCl
469469

470470
/**
471471
* <fullname>Amazon Connect Customer Profiles</fullname>
472-
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact center that has
473-
* pre-built connectors powered by AppFlow that make it easy to combine customer information
474-
* from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your
475-
* enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
476-
* If you're new to Amazon Connect, you might find it helpful to review the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/">Amazon Connect Administrator Guide</a>.</p>
472+
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact
473+
* center that has pre-built connectors powered by AppFlow that make it easy to combine
474+
* customer information from third party applications, such as Salesforce (CRM), ServiceNow
475+
* (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. </p>
476+
* <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
477+
* Profiles</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>
477478
* @public
478479
*/
479480
export class CustomerProfilesClient extends __Client<

‎clients/client-customer-profiles/src/commands/CreateCalculatedAttributeDefinitionCommand.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ export interface CreateCalculatedAttributeDefinitionCommandOutput
4040
/**
4141
* <p>Creates a new calculated attribute definition. After creation, new object data ingested
4242
* into Customer Profiles will be included in the calculated attribute, which can be retrieved
43-
* for a profile using the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetCalculatedAttributeForProfile.html">GetCalculatedAttributeForProfile</a> API.
44-
* Defining a calculated attribute makes it available for all profiles within a domain. Each
45-
* calculated attribute can only reference one <code>ObjectType</code> and at most, two fields
46-
* from that <code>ObjectType</code>.</p>
43+
* 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
44+
* available for all profiles within a domain. Each calculated attribute can only reference
45+
* one <code>ObjectType</code> and at most, two fields from that
46+
* <code>ObjectType</code>.</p>
4747
* @example
4848
* Use a bare-bones client and the command you need to make an API call.
4949
* ```javascript

‎clients/client-customer-profiles/src/commands/CreateDomainCommand.ts

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,20 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
3131
* <p>Creates a domain, which is a container for all customer data, such as customer profile
3232
* attributes, object types, profile keys, and encryption keys. You can create multiple
3333
* domains, and each domain can have multiple third-party integrations.</p>
34-
* <p>Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can
35-
* be associated with one domain.</p>
34+
* <p>Each Amazon Connect instance can be associated with only one domain. Multiple
35+
* Amazon Connect instances can be associated with one domain.</p>
3636
* <p>Use this API or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to
3737
* enable <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">identity
3838
* resolution</a>: set <code>Matching</code> to true.</p>
3939
* <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
4040
* apply. </p>
41+
* <note>
42+
* <p>It is not possible to associate a Customer Profiles domain with an Amazon Connect Instance directly from
43+
* the API. If you would like to create a domain and associate a Customer Profiles domain, use the Amazon Connect
44+
* 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>
45+
* <p>Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances
46+
* can be associated with one domain.</p>
47+
* </note>
4148
* @example
4249
* Use a bare-bones client and the command you need to make an API call.
4350
* ```javascript

‎clients/client-customer-profiles/src/commands/CreateEventStreamCommand.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ export interface CreateEventStreamCommandInput extends CreateEventStreamRequest
2828
export interface CreateEventStreamCommandOutput extends CreateEventStreamResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates an event stream, which is a subscription to real-time events, such as when profiles are created and
32-
* updated through Amazon Connect Customer Profiles.</p>
33-
* <p>Each event stream can be associated with only one Kinesis Data Stream destination in the same region and
34-
* Amazon Web Services account as the customer profiles domain</p>
31+
* <p>Creates an event stream, which is a subscription to real-time events, such as when
32+
* profiles are created and updated through Amazon Connect Customer Profiles.</p>
33+
* <p>Each event stream can be associated with only one Kinesis Data Stream destination in the
34+
* same region and Amazon Web Services account as the customer profiles domain</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
3737
* ```javascript

‎clients/client-customer-profiles/src/commands/CreateIntegrationWorkflowCommand.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,8 @@ export interface CreateIntegrationWorkflowCommandInput extends CreateIntegration
3232
export interface CreateIntegrationWorkflowCommandOutput extends CreateIntegrationWorkflowResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>
36-
* Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo.
37-
* </p>
35+
* <p> Creates an integration workflow. An integration workflow is an async process which
36+
* ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo. </p>
3837
* @example
3938
* Use a bare-bones client and the command you need to make an API call.
4039
* ```javascript

‎clients/client-customer-profiles/src/commands/DeleteCalculatedAttributeDefinitionCommand.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,10 @@ export interface DeleteCalculatedAttributeDefinitionCommandOutput
3636
__MetadataBearer {}
3737

3838
/**
39-
* <p>Deletes an existing calculated attribute definition. Note that deleting a default calculated attribute
40-
* is possible, however once deleted, you will be unable to undo that action and will need to recreate it on
41-
* your own using the CreateCalculatedAttributeDefinition API if you want it back.</p>
39+
* <p>Deletes an existing calculated attribute definition. Note that deleting a default
40+
* calculated attribute is possible, however once deleted, you will be unable to undo that
41+
* action and will need to recreate it on your own using the
42+
* CreateCalculatedAttributeDefinition API if you want it back.</p>
4243
* @example
4344
* Use a bare-bones client and the command you need to make an API call.
4445
* ```javascript

‎clients/client-customer-profiles/src/commands/DeleteWorkflowCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ export interface DeleteWorkflowCommandInput extends DeleteWorkflowRequest {}
2828
export interface DeleteWorkflowCommandOutput extends DeleteWorkflowResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes the specified workflow and all its corresponding resources. This is an async process.</p>
31+
* <p>Deletes the specified workflow and all its corresponding resources. This is an async
32+
* process.</p>
3233
* @example
3334
* Use a bare-bones client and the command you need to make an API call.
3435
* ```javascript

‎clients/client-customer-profiles/src/commands/GetCalculatedAttributeDefinitionCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ export interface GetCalculatedAttributeDefinitionCommandOutput
3737
__MetadataBearer {}
3838

3939
/**
40-
* <p>Provides more information on a calculated attribute definition for Customer Profiles.</p>
40+
* <p>Provides more information on a calculated attribute definition for Customer
41+
* Profiles.</p>
4142
* @example
4243
* Use a bare-bones client and the command you need to make an API call.
4344
* ```javascript

‎clients/client-customer-profiles/src/commands/GetProfileObjectTypeCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ export interface GetProfileObjectTypeCommandOutput extends GetProfileObjectTypeR
5353
* // EncryptionKey: "STRING_VALUE",
5454
* // AllowProfileCreation: true || false,
5555
* // SourceLastUpdatedTimestampFormat: "STRING_VALUE",
56+
* // MaxAvailableProfileObjectCount: Number("int"),
57+
* // MaxProfileObjectCount: Number("int"),
5658
* // Fields: { // FieldMap
5759
* // "<keys>": { // ObjectTypeField
5860
* // Source: "STRING_VALUE",

‎clients/client-customer-profiles/src/commands/GetSimilarProfilesCommand.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,10 @@ export interface GetSimilarProfilesCommandInput extends GetSimilarProfilesReques
2828
export interface GetSimilarProfilesCommandOutput extends GetSimilarProfilesResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns a set of profiles that belong to the same matching group using the <code>matchId</code> or
32-
* <code>profileId</code>. You can also specify the type of matching that you want for finding similar profiles using
33-
* either <code>RULE_BASED_MATCHING</code> or <code>ML_BASED_MATCHING</code>.</p>
31+
* <p>Returns a set of profiles that belong to the same matching group using the
32+
* <code>matchId</code> or <code>profileId</code>. You can also specify the type of
33+
* matching that you want for finding similar profiles using either
34+
* <code>RULE_BASED_MATCHING</code> or <code>ML_BASED_MATCHING</code>.</p>
3435
* @example
3536
* Use a bare-bones client and the command you need to make an API call.
3637
* ```javascript

‎clients/client-customer-profiles/src/commands/ListProfileObjectTypesCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ export interface ListProfileObjectTypesCommandOutput extends ListProfileObjectTy
5353
* // Description: "STRING_VALUE", // required
5454
* // CreatedAt: new Date("TIMESTAMP"),
5555
* // LastUpdatedAt: new Date("TIMESTAMP"),
56+
* // MaxProfileObjectCount: Number("int"),
57+
* // MaxAvailableProfileObjectCount: Number("int"),
5658
* // Tags: { // TagMap
5759
* // "<keys>": "STRING_VALUE",
5860
* // },

‎clients/client-customer-profiles/src/commands/PutIntegrationCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export interface PutIntegrationCommandOutput extends PutIntegrationResponse, __M
3636
* Amazon AppFlow and Amazon Connect.</p>
3737
* <p>An integration can belong to only one domain.</p>
3838
* <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
39-
* </a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">
39+
* </a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">
4040
* UntagResource</a>.</p>
4141
* @example
4242
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-customer-profiles/src/commands/PutProfileObjectTypeCommand.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export interface PutProfileObjectTypeCommandOutput extends PutProfileObjectTypeR
3535
/**
3636
* <p>Defines a ProfileObjectType.</p>
3737
* <p>To add or remove tags on an existing ObjectType, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html">
38-
* TagResource</a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
38+
* TagResource</a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
3939
* @example
4040
* Use a bare-bones client and the command you need to make an API call.
4141
* ```javascript
@@ -51,6 +51,7 @@ export interface PutProfileObjectTypeCommandOutput extends PutProfileObjectTypeR
5151
* EncryptionKey: "STRING_VALUE",
5252
* AllowProfileCreation: true || false,
5353
* SourceLastUpdatedTimestampFormat: "STRING_VALUE",
54+
* MaxProfileObjectCount: Number("int"),
5455
* Fields: { // FieldMap
5556
* "<keys>": { // ObjectTypeField
5657
* Source: "STRING_VALUE",
@@ -84,6 +85,8 @@ export interface PutProfileObjectTypeCommandOutput extends PutProfileObjectTypeR
8485
* // EncryptionKey: "STRING_VALUE",
8586
* // AllowProfileCreation: true || false,
8687
* // SourceLastUpdatedTimestampFormat: "STRING_VALUE",
88+
* // MaxProfileObjectCount: Number("int"),
89+
* // MaxAvailableProfileObjectCount: Number("int"),
8790
* // Fields: { // FieldMap
8891
* // "<keys>": { // ObjectTypeField
8992
* // Source: "STRING_VALUE",

‎clients/client-customer-profiles/src/commands/SearchProfilesCommand.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,11 @@ export interface SearchProfilesCommandOutput extends SearchProfilesResponse, __M
3333

3434
/**
3535
* <p>Searches for profiles within a specific domain using one or more predefined search keys
36-
* (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A search key
37-
* is a data type pair that consists of a <code>KeyName</code> and <code>Values</code> list.</p>
38-
* <p>This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to
39-
* 5 key-value(s) pairs using either <code>AND</code> or <code>OR</code> logic.</p>
36+
* (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A
37+
* search key is a data type pair that consists of a <code>KeyName</code> and
38+
* <code>Values</code> list.</p>
39+
* <p>This operation supports searching for profiles with a minimum of 1 key-value(s) pair and
40+
* up to 5 key-value(s) pairs using either <code>AND</code> or <code>OR</code> logic.</p>
4041
* @example
4142
* Use a bare-bones client and the command you need to make an API call.
4243
* ```javascript

‎clients/client-customer-profiles/src/commands/UpdateCalculatedAttributeDefinitionCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ export interface UpdateCalculatedAttributeDefinitionCommandOutput
3838
__MetadataBearer {}
3939

4040
/**
41-
* <p>Updates an existing calculated attribute definition. When updating the Conditions, note that increasing
42-
* the date range of a calculated attribute will not trigger inclusion of historical data greater than the
43-
* current date range.</p>
41+
* <p>Updates an existing calculated attribute definition. When updating the Conditions, note
42+
* that increasing the date range of a calculated attribute will not trigger inclusion of
43+
* historical data greater than the current date range.</p>
4444
* @example
4545
* Use a bare-bones client and the command you need to make an API call.
4646
* ```javascript

‎clients/client-customer-profiles/src/index.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22
/* eslint-disable */
33
/**
44
* <fullname>Amazon Connect Customer Profiles</fullname>
5-
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact center that has
6-
* pre-built connectors powered by AppFlow that make it easy to combine customer information
7-
* from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your
8-
* enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
9-
* If you're new to Amazon Connect, you might find it helpful to review the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/">Amazon Connect Administrator Guide</a>.</p>
5+
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact
6+
* center that has pre-built connectors powered by AppFlow that make it easy to combine
7+
* customer information from third party applications, such as Salesforce (CRM), ServiceNow
8+
* (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. </p>
9+
* <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
10+
* Profiles</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>
1011
*
1112
* @packageDocumentation
1213
*/

0 commit comments

Comments
 (0)