@aws-sdk/client-pinpoint-email

Description

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

Amazon Pinpoint Email Service

Welcome to the Amazon Pinpoint Email API Reference. This guide provides
information about the Amazon Pinpoint Email API (version 1.0), including supported
operations, data types, parameters, and schemas.

Amazon Pinpoint is an AWS service that you
can use to engage with your customers across multiple messaging channels. You can use
Amazon Pinpoint to send email, SMS text messages, voice messages, and push notifications. The
Amazon Pinpoint Email API provides programmatic access to options that are unique to the
email channel and supplement the options provided by the Amazon Pinpoint API.

If you're new to Amazon Pinpoint, you might find it helpful to also review the Amazon
Pinpoint Developer Guide. The Amazon Pinpoint Developer
Guide provides tutorials, code samples, and procedures that demonstrate
how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into
mobile apps and other types of applications. The guide also provides information about
key topics such as Amazon Pinpoint integration with other AWS services and the limits that apply
to using the service.

The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint
for each of these Regions. For a list of all the Regions and endpoints where the API is
currently available, see AWS Service Endpoints in
the Amazon Web Services General Reference. To learn more about AWS Regions, see
Managing AWS
Regions in the Amazon Web Services General Reference.

In each Region, AWS maintains multiple Availability Zones. These Availability Zones
are physically isolated from each other, but are united by private, low-latency,
high-throughput, and highly redundant network connections. These Availability Zones
enable us to provide very high levels of availability and redundancy, while also
minimizing latency. To learn more about the number of Availability Zones that are
available in each Region, see AWS Global Infrastructure.

Installing

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

Getting Started

$3

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

``js
// ES5 example
const { PinpointEmailClient, ListConfigurationSetsCommand } = require("@aws-sdk/client-pinpoint-email");
`

`ts
// ES6+ example
import { PinpointEmailClient, ListConfigurationSetsCommand } from "@aws-sdk/client-pinpoint-email";
`

$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 PinpointEmailClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListConfigurationSetsCommand(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-pinpoint-email";
const client = new AWS.PinpointEmail({ region: "REGION" });

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

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

// callbacks.
client.listConfigurationSets(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-pinpoint-email` 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)

CreateConfigurationSet

Command API Reference / Input / Output

CreateConfigurationSetEventDestination

Command API Reference / Input / Output

CreateDedicatedIpPool

Command API Reference / Input / Output

CreateDeliverabilityTestReport

Command API Reference / Input / Output

CreateEmailIdentity

Command API Reference / Input / Output

DeleteConfigurationSet

Command API Reference / Input / Output

DeleteConfigurationSetEventDestination

Command API Reference / Input / Output

DeleteDedicatedIpPool

Command API Reference / Input / Output

DeleteEmailIdentity

Command API Reference / Input / Output

GetAccount

Command API Reference / Input / Output

GetBlacklistReports

Command API Reference / Input / Output

GetConfigurationSet

Command API Reference / Input / Output

GetConfigurationSetEventDestinations

Command API Reference / Input / Output

GetDedicatedIp

Command API Reference / Input / Output

GetDedicatedIps

Command API Reference / Input / Output

GetDeliverabilityDashboardOptions

Command API Reference / Input / Output

GetDeliverabilityTestReport

Command API Reference / Input / Output

GetDomainDeliverabilityCampaign

Command API Reference / Input / Output

GetDomainStatisticsReport

Command API Reference / Input / Output

GetEmailIdentity

Command API Reference / Input / Output

ListConfigurationSets

Command API Reference / Input / Output

ListDedicatedIpPools

Command API Reference / Input / Output

ListDeliverabilityTestReports

Command API Reference / Input / Output

ListDomainDeliverabilityCampaigns

Command API Reference / Input / Output

ListEmailIdentities

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

PutAccountDedicatedIpWarmupAttributes

Command API Reference / Input / Output

PutAccountSendingAttributes

Command API Reference / Input / Output

PutConfigurationSetDeliveryOptions

Command API Reference / Input / Output

PutConfigurationSetReputationOptions

Command API Reference / Input / Output

PutConfigurationSetSendingOptions

Command API Reference / Input / Output

PutConfigurationSetTrackingOptions

Command API Reference / Input / Output

PutDedicatedIpInPool

Command API Reference / Input / Output

PutDedicatedIpWarmupAttributes

Command API Reference / Input / Output

PutDeliverabilityDashboardOption

Command API Reference / Input / Output

PutEmailIdentityDkimAttributes

Command API Reference / Input / Output

PutEmailIdentityFeedbackAttributes

Command API Reference / Input / Output

PutEmailIdentityMailFromAttributes

Command API Reference / Input / Output

SendEmail

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateConfigurationSetEventDestination

Command API Reference / Input / Output