@aws-sdk/client-customer-profiles

Description

AWS SDK for JavaScript CustomerProfiles Client for Node.js, Browser and React Native.

Amazon Connect Customer Profiles

• 
  

  
  Customer Profiles actions
  

  
  


• 
  

  
  Customer Profiles data types
  

  
  

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.

For more information about the Amazon Connect Customer Profiles feature, see Use Customer
Profiles in the Amazon Connect Administrator's Guide.

Installing

To install this package, simply type add or install @aws-sdk/client-customer-profiles
using your favorite package manager:
- npm install @aws-sdk/client-customer-profiles
- yarn add @aws-sdk/client-customer-profiles
- pnpm add @aws-sdk/client-customer-profiles

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the CustomerProfilesClient and
the commands you need, for example ListDomainsCommand:

``js
// ES5 example
const { CustomerProfilesClient, ListDomainsCommand } = require("@aws-sdk/client-customer-profiles");
`

`ts
// ES6+ example
import { CustomerProfilesClient, ListDomainsCommand } from "@aws-sdk/client-customer-profiles";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new CustomerProfilesClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListDomainsCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-customer-profiles";
const client = new AWS.CustomerProfiles({ region: "REGION" });

// async/await.
try {
const data = await client.listDomains(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listDomains(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listDomains(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-customer-profiles` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

AddProfileKey

Command API Reference / Input / Output

BatchGetCalculatedAttributeForProfile

Command API Reference / Input / Output

BatchGetProfile

Command API Reference / Input / Output

CreateCalculatedAttributeDefinition

Command API Reference / Input / Output

CreateDomain

Command API Reference / Input / Output

CreateDomainLayout

Command API Reference / Input / Output

CreateEventStream

Command API Reference / Input / Output

CreateEventTrigger

Command API Reference / Input / Output

CreateIntegrationWorkflow

Command API Reference / Input / Output

CreateProfile

Command API Reference / Input / Output

CreateRecommender

Command API Reference / Input / Output

CreateSegmentDefinition

Command API Reference / Input / Output

CreateSegmentEstimate

Command API Reference / Input / Output

CreateSegmentSnapshot

Command API Reference / Input / Output

CreateUploadJob

Command API Reference / Input / Output

DeleteCalculatedAttributeDefinition

Command API Reference / Input / Output

DeleteDomain

Command API Reference / Input / Output

DeleteDomainLayout

Command API Reference / Input / Output

DeleteDomainObjectType

Command API Reference / Input / Output

DeleteEventStream

Command API Reference / Input / Output

DeleteEventTrigger

Command API Reference / Input / Output

DeleteIntegration

Command API Reference / Input / Output

DeleteProfile

Command API Reference / Input / Output

DeleteProfileKey

Command API Reference / Input / Output

DeleteProfileObject

Command API Reference / Input / Output

DeleteProfileObjectType

Command API Reference / Input / Output

DeleteRecommender

Command API Reference / Input / Output

DeleteSegmentDefinition

Command API Reference / Input / Output

DeleteWorkflow

Command API Reference / Input / Output

DetectProfileObjectType

Command API Reference / Input / Output

GetAutoMergingPreview

Command API Reference / Input / Output

GetCalculatedAttributeDefinition

Command API Reference / Input / Output

GetCalculatedAttributeForProfile

Command API Reference / Input / Output

GetDomain

Command API Reference / Input / Output

GetDomainLayout

Command API Reference / Input / Output

GetDomainObjectType

Command API Reference / Input / Output

GetEventStream

Command API Reference / Input / Output

GetEventTrigger

Command API Reference / Input / Output

GetIdentityResolutionJob

Command API Reference / Input / Output

GetIntegration

Command API Reference / Input / Output

GetMatches

Command API Reference / Input / Output

GetObjectTypeAttributeStatistics

Command API Reference / Input / Output

GetProfileHistoryRecord

Command API Reference / Input / Output

GetProfileObjectType

Command API Reference / Input / Output

GetProfileObjectTypeTemplate

Command API Reference / Input / Output

GetProfileRecommendations

Command API Reference / Input / Output

GetRecommender

Command API Reference / Input / Output

GetSegmentDefinition

Command API Reference / Input / Output

GetSegmentEstimate

Command API Reference / Input / Output

GetSegmentMembership

Command API Reference / Input / Output

GetSegmentSnapshot

Command API Reference / Input / Output

GetSimilarProfiles

Command API Reference / Input / Output

GetUploadJob

Command API Reference / Input / Output

GetUploadJobPath

Command API Reference / Input / Output

GetWorkflow

Command API Reference / Input / Output

GetWorkflowSteps

Command API Reference / Input / Output

ListAccountIntegrations

Command API Reference / Input / Output

ListCalculatedAttributeDefinitions

Command API Reference / Input / Output

ListCalculatedAttributesForProfile

Command API Reference / Input / Output

ListDomainLayouts

Command API Reference / Input / Output

ListDomainObjectTypes

Command API Reference / Input / Output

ListDomains

Command API Reference / Input / Output

ListEventStreams

Command API Reference / Input / Output

ListEventTriggers

Command API Reference / Input / Output

ListIdentityResolutionJobs

Command API Reference / Input / Output

ListIntegrations

Command API Reference / Input / Output

ListObjectTypeAttributes

Command API Reference / Input / Output

ListObjectTypeAttributeValues

Command API Reference / Input / Output

ListProfileAttributeValues

Command API Reference / Input / Output

ListProfileHistoryRecords

Command API Reference / Input / Output

ListProfileObjects

Command API Reference / Input / Output

ListProfileObjectTypes

Command API Reference / Input / Output

ListProfileObjectTypeTemplates

Command API Reference / Input / Output

ListRecommenderRecipes

Command API Reference / Input / Output

ListRecommenders

Command API Reference / Input / Output

ListRuleBasedMatches

Command API Reference / Input / Output

ListSegmentDefinitions

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListUploadJobs

Command API Reference / Input / Output

ListWorkflows

Command API Reference / Input / Output

MergeProfiles

Command API Reference / Input / Output

PutDomainObjectType

Command API Reference / Input / Output

PutIntegration

Command API Reference / Input / Output

PutProfileObject

Command API Reference / Input / Output

PutProfileObjectType

Command API Reference / Input / Output

SearchProfiles

Command API Reference / Input / Output

StartRecommender

Command API Reference / Input / Output

StartUploadJob

Command API Reference / Input / Output

StopRecommender

Command API Reference / Input / Output

StopUploadJob

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateCalculatedAttributeDefinition

Command API Reference / Input / Output

UpdateDomain

Command API Reference / Input / Output

UpdateDomainLayout

Command API Reference / Input / Output

UpdateEventTrigger

Command API Reference / Input / Output

UpdateProfile

Command API Reference / Input / Output

UpdateRecommender

Command API Reference / Input / Output