Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class CreateConfigurationSetCommandProtected

Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Example

Use a bare-bones client and the command you need to make an API call.

import { PinpointEmailClient, CreateConfigurationSetCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import
// const { PinpointEmailClient, CreateConfigurationSetCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import
const client = new PinpointEmailClient(config);
const input = { // CreateConfigurationSetRequest
ConfigurationSetName: "STRING_VALUE", // required
TrackingOptions: { // TrackingOptions
CustomRedirectDomain: "STRING_VALUE", // required
},
DeliveryOptions: { // DeliveryOptions
TlsPolicy: "STRING_VALUE",
SendingPoolName: "STRING_VALUE",
},
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
},
],
};
const command = new CreateConfigurationSetCommand(input);
const response = await client.send(command);
// {};

Param

CreateConfigurationSetCommandInput

Returns

CreateConfigurationSetCommandOutput

See

Throws

AlreadyExistsException (client fault)

The resource specified in your request already exists.

Throws

BadRequestException (client fault)

The input you provided is invalid.

Throws

ConcurrentModificationException (server fault)

The resource is being modified by another operation or thread.

Throws

LimitExceededException (client fault)

There are too many instances of the specified resource type.

Throws

NotFoundException (client fault)

The resource you attempted to access doesn't exist.

Throws

TooManyRequestsException (client fault)

Too many requests have been made to the operation.

Throws

PinpointEmailServiceException

Base exception class for all service exceptions from PinpointEmail service.

Hierarchy

Constructors

Properties

Methods