- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateConfigurationSetCommand
Create a configuration set. Configuration sets are groups of rules that you can apply to the emails that you send. You apply a configuration set to an email by specifying the name of the configuration set when you call the Amazon SES API v2. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SESv2Client, CreateConfigurationSetCommand } from "@aws-sdk/client-sesv2"; // ES Modules import
// const { SESv2Client, CreateConfigurationSetCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import
const client = new SESv2Client(config);
const input = { // CreateConfigurationSetRequest
ConfigurationSetName: "STRING_VALUE", // required
TrackingOptions: { // TrackingOptions
CustomRedirectDomain: "STRING_VALUE", // required
HttpsPolicy: "REQUIRE" || "REQUIRE_OPEN_ONLY" || "OPTIONAL",
},
DeliveryOptions: { // DeliveryOptions
TlsPolicy: "REQUIRE" || "OPTIONAL",
SendingPoolName: "STRING_VALUE",
MaxDeliverySeconds: Number("long"),
},
ReputationOptions: { // ReputationOptions
ReputationMetricsEnabled: true || false,
LastFreshStart: new Date("TIMESTAMP"),
},
SendingOptions: { // SendingOptions
SendingEnabled: true || false,
},
Tags: [ // TagList
{ // Tag
Key: "STRING_VALUE", // required
Value: "STRING_VALUE", // required
},
],
SuppressionOptions: { // SuppressionOptions
SuppressedReasons: [ // SuppressionListReasons
"BOUNCE" || "COMPLAINT",
],
},
VdmOptions: { // VdmOptions
DashboardOptions: { // DashboardOptions
EngagementMetrics: "ENABLED" || "DISABLED",
},
GuardianOptions: { // GuardianOptions
OptimizedSharedDelivery: "ENABLED" || "DISABLED",
},
},
ArchivingOptions: { // ArchivingOptions
ArchiveArn: "STRING_VALUE",
},
};
const command = new CreateConfigurationSetCommand(input);
const response = await client.send(command);
// {};
CreateConfigurationSetCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ConfigurationSetName Required | string | undefined | The name of the configuration set. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only. |
ArchivingOptions | ArchivingOptions | undefined | An object that defines the MailManager archiving options for emails that you send using the configuration set. |
DeliveryOptions | DeliveryOptions | undefined | An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. |
ReputationOptions | ReputationOptions | undefined | An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set. |
SendingOptions | SendingOptions | undefined | An object that defines whether or not Amazon SES can send email that you send using the configuration set. |
SuppressionOptions | SuppressionOptions | undefined | An object that contains information about the suppression list preferences for your account. |
Tags | Tag[] | undefined | An array of objects that define the tags (keys and values) to associate with the configuration set. |
TrackingOptions | TrackingOptions | undefined | An object that defines the open and click tracking options for emails that you send using the configuration set. |
VdmOptions | VdmOptions | undefined | An object that defines the VDM options for emails that you send using the configuration set. |
CreateConfigurationSetCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AlreadyExistsException | client | The resource specified in your request already exists. |
BadRequestException | client | The input you provided is invalid. |
ConcurrentModificationException | server | The resource is being modified by another operation or thread. |
LimitExceededException | client | There are too many instances of the specified resource type. |
NotFoundException | client | The resource you attempted to access doesn't exist. |
TooManyRequestsException | client | Too many requests have been made to the operation. |
SESv2ServiceException | Base exception class for all service exceptions from SESv2 service. |