@aws-sdk/client-customer-profiles
Advanced tools
AWS SDK for JavaScript Customer Profiles Client for Node.js, Browser and React Native
AWS SDK for JavaScript CustomerProfiles Client for Node.js, Browser and React Native.
Amazon Connect Customer Profiles
Welcome to the Amazon Connect Customer Profiles API Reference. This guide provides information about the Amazon Connect Customer Profiles API, including supported operations, data types, parameters, and schemas.
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 also review the Amazon Connect Administrator Guide.
To install the this package, simply type add or install @aws-sdk/client-customer-profiles using your favorite package manager:
npm install @aws-sdk/client-customer-profilesyarn add @aws-sdk/client-customer-profilespnpm add @aws-sdk/client-customer-profilesThe 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 AddProfileKeyCommand:
// ES5 example
const { CustomerProfilesClient, AddProfileKeyCommand } = require("@aws-sdk/client-customer-profiles");
// ES6+ example
import { CustomerProfilesClient, AddProfileKeyCommand } from "@aws-sdk/client-customer-profiles";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new CustomerProfilesClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new AddProfileKeyCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// 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.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// proccess err and data.
});
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
import * as AWS from "@aws-sdk/client-customer-profiles";
const client = new AWS.CustomerProfiles({ region: "REGION" });
// async/await.
try {
const data = await client.addProfileKey(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.addProfileKey(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.addProfileKey(params, (err, data) => {
// proccess err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
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;
* }
*/
}
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.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
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.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.19.0 (2021-06-24)
FAQs
AWS SDK for JavaScript Customer Profiles Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-customer-profiles receives a total of 37,708 weekly downloads. As such, @aws-sdk/client-customer-profiles popularity was classified as popular.
We found that @aws-sdk/client-customer-profiles demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.