@aws-sdk/client-ses
v3.665.0@aws-sdk/client-ses
Description
AWS SDK for JavaScript SES Client for Node.js, Browser and React Native.
This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version 2010-12-01. This document is best used in conjunction with the Amazon SES Developer Guide.
For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.
This documentation contains reference information related to the following:
Installing
To install the this package, simply type add or install @aws-sdk/client-ses using your favorite package manager:
npm install @aws-sdk/client-ses
yarn add @aws-sdk/client-ses
pnpm add @aws-sdk/client-ses
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the SESClient
and
the commands you need, for example ListIdentitiesCommand
:
// ES5 example
const { SESClient, ListIdentitiesCommand } = require("@aws-sdk/client-ses");
// ES6+ example
import { SESClient, ListIdentitiesCommand } from "@aws-sdk/client-ses";
Usage
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.
// a client can be shared by different commands.
const client = new SESClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListIdentitiesCommand(params);
Async/await
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.
Promises
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.
});
Callbacks
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.
});
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
import * as AWS from "@aws-sdk/client-ses";
const client = new AWS.SES({ region: "REGION" });
// async/await.
try {
const data = await client.listIdentities(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listIdentities(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listIdentities(params, (err, data) => {
// process err and data.
});
Troubleshooting
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;
* }
*/
}
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-ses
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)
CloneReceiptRuleSet
CreateConfigurationSet
CreateConfigurationSetEventDestination
CreateConfigurationSetTrackingOptions
CreateCustomVerificationEmailTemplate
CreateReceiptFilter
CreateReceiptRule
CreateReceiptRuleSet
CreateTemplate
DeleteConfigurationSet
DeleteConfigurationSetEventDestination
DeleteConfigurationSetTrackingOptions
DeleteCustomVerificationEmailTemplate
DeleteIdentity
DeleteIdentityPolicy
DeleteReceiptFilter
DeleteReceiptRule
DeleteReceiptRuleSet
DeleteTemplate
DeleteVerifiedEmailAddress
DescribeActiveReceiptRuleSet
DescribeConfigurationSet
DescribeReceiptRule
DescribeReceiptRuleSet
GetAccountSendingEnabled
GetCustomVerificationEmailTemplate
GetIdentityDkimAttributes
GetIdentityMailFromDomainAttributes
GetIdentityNotificationAttributes
GetIdentityPolicies
GetIdentityVerificationAttributes
GetSendQuota
GetSendStatistics
GetTemplate
ListConfigurationSets
ListCustomVerificationEmailTemplates
ListIdentities
ListIdentityPolicies
ListReceiptFilters
ListReceiptRuleSets
ListTemplates
ListVerifiedEmailAddresses
PutConfigurationSetDeliveryOptions
PutIdentityPolicy
ReorderReceiptRuleSet
SendBounce
SendBulkTemplatedEmail
SendCustomVerificationEmail
SendEmail
SendRawEmail
SendTemplatedEmail
SetActiveReceiptRuleSet
SetIdentityDkimEnabled
SetIdentityFeedbackForwardingEnabled
SetIdentityHeadersInNotificationsEnabled
SetIdentityMailFromDomain
SetIdentityNotificationTopic
SetReceiptRulePosition
TestRenderTemplate
UpdateAccountSendingEnabled
UpdateConfigurationSetEventDestination
UpdateConfigurationSetReputationMetricsEnabled
UpdateConfigurationSetSendingEnabled
UpdateConfigurationSetTrackingOptions
UpdateCustomVerificationEmailTemplate
UpdateReceiptRule
UpdateTemplate
VerifyDomainDkim
VerifyDomainIdentity
VerifyEmailAddress
VerifyEmailIdentity
Metadata
- Apache-2.0
- >=16.0.0
- AWS SDK for JavaScript Team
- released 10/4/2024