Skip to content

Commit

Permalink
feat(client-customer-profiles): This release includes changes to Prof…
Browse files Browse the repository at this point in the history
…ileObjectType APIs, adds functionality top set and get capacity for profile object types.
  • Loading branch information
awstools committed Jun 24, 2024
1 parent 55c8f49 commit a72bef5
Show file tree
Hide file tree
Showing 21 changed files with 451 additions and 267 deletions.
11 changes: 6 additions & 5 deletions clients/client-customer-profiles/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ AWS SDK for JavaScript CustomerProfiles Client for Node.js, Browser and React Na

<fullname>Amazon Connect Customer Profiles</fullname>

<p>Amazon Connect Customer Profiles is a unified customer profile for your contact center that has
pre-built connectors powered by AppFlow that make it easy to combine customer information
from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your
enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
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>
<p>Amazon Connect Customer Profiles is a unified customer profile for your contact
center that has pre-built connectors powered by AppFlow that make it easy to combine
customer information from third party applications, such as Salesforce (CRM), ServiceNow
(ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. </p>
<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
Profiles</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>

## Installing

Expand Down
11 changes: 6 additions & 5 deletions clients/client-customer-profiles/src/CustomerProfiles.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1084,11 +1084,12 @@ export interface CustomerProfiles {

/**
* <fullname>Amazon Connect Customer Profiles</fullname>
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact center that has
* pre-built connectors powered by AppFlow that make it easy to combine customer information
* from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your
* enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
* 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>
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact
* center that has pre-built connectors powered by AppFlow that make it easy to combine
* customer information from third party applications, such as Salesforce (CRM), ServiceNow
* (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. </p>
* <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
* Profiles</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>
* @public
*/
export class CustomerProfiles extends CustomerProfilesClient implements CustomerProfiles {}
Expand Down
11 changes: 6 additions & 5 deletions clients/client-customer-profiles/src/CustomerProfilesClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -469,11 +469,12 @@ export interface CustomerProfilesClientResolvedConfig extends CustomerProfilesCl

/**
* <fullname>Amazon Connect Customer Profiles</fullname>
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact center that has
* pre-built connectors powered by AppFlow that make it easy to combine customer information
* from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your
* enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
* 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>
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact
* center that has pre-built connectors powered by AppFlow that make it easy to combine
* customer information from third party applications, such as Salesforce (CRM), ServiceNow
* (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. </p>
* <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
* Profiles</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>
* @public
*/
export class CustomerProfilesClient extends __Client<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ export interface CreateCalculatedAttributeDefinitionCommandOutput
/**
* <p>Creates a new calculated attribute definition. After creation, new object data ingested
* into Customer Profiles will be included in the calculated attribute, which can be retrieved
* 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 available for all profiles within a domain. Each
* calculated attribute can only reference one <code>ObjectType</code> and at most, two fields
* from that <code>ObjectType</code>.</p>
* 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
* available for all profiles within a domain. Each calculated attribute can only reference
* one <code>ObjectType</code> and at most, two fields from that
* <code>ObjectType</code>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,20 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
* <p>Creates a domain, which is a container for all customer data, such as customer profile
* attributes, object types, profile keys, and encryption keys. You can create multiple
* domains, and each domain can have multiple third-party integrations.</p>
* <p>Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can
* be associated with one domain.</p>
* <p>Each Amazon Connect instance can be associated with only one domain. Multiple
* Amazon Connect instances can be associated with one domain.</p>
* <p>Use this API or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to
* enable <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">identity
* resolution</a>: set <code>Matching</code> to true.</p>
* <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
* apply. </p>
* <note>
* <p>It is not possible to associate a Customer Profiles domain with an Amazon Connect Instance directly from
* the API. If you would like to create a domain and associate a Customer Profiles domain, use the Amazon Connect
* 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>
* <p>Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances
* can be associated with one domain.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ export interface CreateEventStreamCommandInput extends CreateEventStreamRequest
export interface CreateEventStreamCommandOutput extends CreateEventStreamResponse, __MetadataBearer {}

/**
* <p>Creates an event stream, which is a subscription to real-time events, such as when profiles are created and
* updated through Amazon Connect Customer Profiles.</p>
* <p>Each event stream can be associated with only one Kinesis Data Stream destination in the same region and
* Amazon Web Services account as the customer profiles domain</p>
* <p>Creates an event stream, which is a subscription to real-time events, such as when
* profiles are created and updated through Amazon Connect Customer Profiles.</p>
* <p>Each event stream can be associated with only one Kinesis Data Stream destination in the
* same region and Amazon Web Services account as the customer profiles domain</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,8 @@ export interface CreateIntegrationWorkflowCommandInput extends CreateIntegration
export interface CreateIntegrationWorkflowCommandOutput extends CreateIntegrationWorkflowResponse, __MetadataBearer {}

/**
* <p>
* 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.
* </p>
* <p> 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. </p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,10 @@ export interface DeleteCalculatedAttributeDefinitionCommandOutput
__MetadataBearer {}

/**
* <p>Deletes an existing calculated attribute definition. Note that deleting a default calculated attribute
* is possible, however once deleted, you will be unable to undo that action and will need to recreate it on
* your own using the CreateCalculatedAttributeDefinition API if you want it back.</p>
* <p>Deletes an existing calculated attribute definition. Note that deleting a default
* calculated attribute is possible, however once deleted, you will be unable to undo that
* action and will need to recreate it on your own using the
* CreateCalculatedAttributeDefinition API if you want it back.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ export interface DeleteWorkflowCommandInput extends DeleteWorkflowRequest {}
export interface DeleteWorkflowCommandOutput extends DeleteWorkflowResponse, __MetadataBearer {}

/**
* <p>Deletes the specified workflow and all its corresponding resources. This is an async process.</p>
* <p>Deletes the specified workflow and all its corresponding resources. This is an async
* process.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ export interface GetCalculatedAttributeDefinitionCommandOutput
__MetadataBearer {}

/**
* <p>Provides more information on a calculated attribute definition for Customer Profiles.</p>
* <p>Provides more information on a calculated attribute definition for Customer
* Profiles.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ export interface GetProfileObjectTypeCommandOutput extends GetProfileObjectTypeR
* // EncryptionKey: "STRING_VALUE",
* // AllowProfileCreation: true || false,
* // SourceLastUpdatedTimestampFormat: "STRING_VALUE",
* // MaxAvailableProfileObjectCount: Number("int"),
* // MaxProfileObjectCount: Number("int"),
* // Fields: { // FieldMap
* // "<keys>": { // ObjectTypeField
* // Source: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,10 @@ export interface GetSimilarProfilesCommandInput extends GetSimilarProfilesReques
export interface GetSimilarProfilesCommandOutput extends GetSimilarProfilesResponse, __MetadataBearer {}

/**
* <p>Returns a set of profiles that belong to the same matching group using the <code>matchId</code> or
* <code>profileId</code>. You can also specify the type of matching that you want for finding similar profiles using
* either <code>RULE_BASED_MATCHING</code> or <code>ML_BASED_MATCHING</code>.</p>
* <p>Returns a set of profiles that belong to the same matching group using the
* <code>matchId</code> or <code>profileId</code>. You can also specify the type of
* matching that you want for finding similar profiles using either
* <code>RULE_BASED_MATCHING</code> or <code>ML_BASED_MATCHING</code>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ export interface ListProfileObjectTypesCommandOutput extends ListProfileObjectTy
* // Description: "STRING_VALUE", // required
* // CreatedAt: new Date("TIMESTAMP"),
* // LastUpdatedAt: new Date("TIMESTAMP"),
* // MaxProfileObjectCount: Number("int"),
* // MaxAvailableProfileObjectCount: Number("int"),
* // Tags: { // TagMap
* // "<keys>": "STRING_VALUE",
* // },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export interface PutIntegrationCommandOutput extends PutIntegrationResponse, __M
* Amazon AppFlow and Amazon Connect.</p>
* <p>An integration can belong to only one domain.</p>
* <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
* </a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">
* </a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">
* UntagResource</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export interface PutProfileObjectTypeCommandOutput extends PutProfileObjectTypeR
/**
* <p>Defines a ProfileObjectType.</p>
* <p>To add or remove tags on an existing ObjectType, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html">
* TagResource</a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
* TagResource</a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand All @@ -51,6 +51,7 @@ export interface PutProfileObjectTypeCommandOutput extends PutProfileObjectTypeR
* EncryptionKey: "STRING_VALUE",
* AllowProfileCreation: true || false,
* SourceLastUpdatedTimestampFormat: "STRING_VALUE",
* MaxProfileObjectCount: Number("int"),
* Fields: { // FieldMap
* "<keys>": { // ObjectTypeField
* Source: "STRING_VALUE",
Expand Down Expand Up @@ -84,6 +85,8 @@ export interface PutProfileObjectTypeCommandOutput extends PutProfileObjectTypeR
* // EncryptionKey: "STRING_VALUE",
* // AllowProfileCreation: true || false,
* // SourceLastUpdatedTimestampFormat: "STRING_VALUE",
* // MaxProfileObjectCount: Number("int"),
* // MaxAvailableProfileObjectCount: Number("int"),
* // Fields: { // FieldMap
* // "<keys>": { // ObjectTypeField
* // Source: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,11 @@ export interface SearchProfilesCommandOutput extends SearchProfilesResponse, __M

/**
* <p>Searches for profiles within a specific domain using one or more predefined search keys
* (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A search key
* is a data type pair that consists of a <code>KeyName</code> and <code>Values</code> list.</p>
* <p>This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to
* 5 key-value(s) pairs using either <code>AND</code> or <code>OR</code> logic.</p>
* (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A
* search key is a data type pair that consists of a <code>KeyName</code> and
* <code>Values</code> list.</p>
* <p>This operation supports searching for profiles with a minimum of 1 key-value(s) pair and
* up to 5 key-value(s) pairs using either <code>AND</code> or <code>OR</code> logic.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ export interface UpdateCalculatedAttributeDefinitionCommandOutput
__MetadataBearer {}

/**
* <p>Updates an existing calculated attribute definition. When updating the Conditions, note that increasing
* the date range of a calculated attribute will not trigger inclusion of historical data greater than the
* current date range.</p>
* <p>Updates an existing calculated attribute definition. When updating the Conditions, note
* that increasing the date range of a calculated attribute will not trigger inclusion of
* historical data greater than the current date range.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
11 changes: 6 additions & 5 deletions clients/client-customer-profiles/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@
/* eslint-disable */
/**
* <fullname>Amazon Connect Customer Profiles</fullname>
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact center that has
* pre-built connectors powered by AppFlow that make it easy to combine customer information
* from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your
* enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
* 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>
* <p>Amazon Connect Customer Profiles is a unified customer profile for your contact
* center that has pre-built connectors powered by AppFlow that make it easy to combine
* customer information from third party applications, such as Salesforce (CRM), ServiceNow
* (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. </p>
* <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
* Profiles</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>
*
* @packageDocumentation
*/
Expand Down
Loading

0 comments on commit a72bef5

Please sign in to comment.