@aws-sdk/client-pinpoint
Advanced tools
AWS SDK for JavaScript Pinpoint Client for Node.js, Browser and React Native
@aws-sdk/client-pinpoint is an AWS SDK for JavaScript package that allows developers to interact with the Amazon Pinpoint service. Amazon Pinpoint is a flexible and scalable outbound and inbound marketing communications service. It enables you to engage with your customers by sending them targeted messages through multiple channels, such as email, SMS, push notifications, and voice messages.
Send Email
This feature allows you to send an email using Amazon Pinpoint. The code sample demonstrates how to configure and send an email message to a recipient.
const { PinpointClient, SendMessagesCommand } = require('@aws-sdk/client-pinpoint');
const client = new PinpointClient({ region: 'us-west-2' });
const params = {
ApplicationId: 'your-application-id',
MessageRequest: {
Addresses: {
'recipient@example.com': {
ChannelType: 'EMAIL'
}
},
MessageConfiguration: {
EmailMessage: {
SimpleEmail: {
Subject: { Data: 'Test Email' },
HtmlPart: { Data: '<h1>Hello</h1><p>This is a test email.</p>' },
TextPart: { Data: 'Hello, This is a test email.' }
}
}
}
}
};
const run = async () => {
try {
const data = await client.send(new SendMessagesCommand(params));
console.log('Success', data);
} catch (err) {
console.error('Error', err);
}
};
run();Send SMS
This feature allows you to send an SMS message using Amazon Pinpoint. The code sample demonstrates how to configure and send an SMS message to a recipient.
const { PinpointClient, SendMessagesCommand } = require('@aws-sdk/client-pinpoint');
const client = new PinpointClient({ region: 'us-west-2' });
const params = {
ApplicationId: 'your-application-id',
MessageRequest: {
Addresses: {
'+1234567890': {
ChannelType: 'SMS'
}
},
MessageConfiguration: {
SMSMessage: {
Body: 'This is a test SMS message.',
MessageType: 'TRANSACTIONAL'
}
}
}
};
const run = async () => {
try {
const data = await client.send(new SendMessagesCommand(params));
console.log('Success', data);
} catch (err) {
console.error('Error', err);
}
};
run();Create Segment
This feature allows you to create a segment in Amazon Pinpoint. The code sample demonstrates how to define and create a segment based on specific criteria.
const { PinpointClient, CreateSegmentCommand } = require('@aws-sdk/client-pinpoint');
const client = new PinpointClient({ region: 'us-west-2' });
const params = {
ApplicationId: 'your-application-id',
WriteSegmentRequest: {
Name: 'TestSegment',
Dimensions: {
Demographic: {
Channel: {
Values: ['EMAIL'],
DimensionType: 'INCLUSIVE'
}
}
}
}
};
const run = async () => {
try {
const data = await client.send(new CreateSegmentCommand(params));
console.log('Success', data);
} catch (err) {
console.error('Error', err);
}
};
run();SendGrid is a cloud-based service that provides email delivery and marketing campaigns. It offers similar functionalities to Amazon Pinpoint's email capabilities, including sending transactional and marketing emails, managing lists, and tracking email performance. However, SendGrid is focused solely on email, whereas Amazon Pinpoint supports multiple communication channels.
Twilio is a cloud communications platform that allows developers to build and manage communication channels such as SMS, voice, and video. Twilio offers similar functionalities to Amazon Pinpoint's SMS and voice capabilities. Twilio is known for its ease of use and extensive API documentation, but it does not provide the same level of integration with other AWS services as Amazon Pinpoint.
Mailchimp is a marketing automation platform and email marketing service. It offers functionalities similar to Amazon Pinpoint's email and campaign management features. Mailchimp provides tools for creating email campaigns, managing subscriber lists, and analyzing campaign performance. Unlike Amazon Pinpoint, Mailchimp is primarily focused on email marketing and does not support other communication channels like SMS or push notifications.
AWS SDK for JavaScript Pinpoint Client for Node.js, Browser and React Native.
Doc Engage API - Amazon Pinpoint API
To install the this package, simply type add or install @aws-sdk/client-pinpoint using your favorite package manager:
npm install @aws-sdk/client-pinpointyarn add @aws-sdk/client-pinpointpnpm add @aws-sdk/client-pinpointThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the PinpointClient and
the commands you need, for example ListTemplatesCommand:
// ES5 example
const { PinpointClient, ListTemplatesCommand } = require("@aws-sdk/client-pinpoint");
// ES6+ example
import { PinpointClient, ListTemplatesCommand } from "@aws-sdk/client-pinpoint";
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 PinpointClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListTemplatesCommand(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) => {
// process 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-pinpoint";
const client = new AWS.Pinpoint({ region: "REGION" });
// async/await.
try {
const data = await client.listTemplates(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listTemplates(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listTemplates(params, (err, data) => {
// process 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-pinpoint 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.669.0 (2024-10-10)
FAQs
AWS SDK for JavaScript Pinpoint Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-pinpoint receives a total of 201,767 weekly downloads. As such, @aws-sdk/client-pinpoint popularity was classified as popular.
We found that @aws-sdk/client-pinpoint demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 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
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.