Class CreateConfigurationSetTrackingOptionsCommandProtected

Creates an association between a configuration set and a custom domain for open and click event tracking.

By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.

Example

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

import { SESClient, CreateConfigurationSetTrackingOptionsCommand } from "@aws-sdk/client-ses"; // ES Modules import
// const { SESClient, CreateConfigurationSetTrackingOptionsCommand } = require("@aws-sdk/client-ses"); // CommonJS import
const client = new SESClient(config);
const input = { // CreateConfigurationSetTrackingOptionsRequest
  ConfigurationSetName: "STRING_VALUE", // required
  TrackingOptions: { // TrackingOptions
    CustomRedirectDomain: "STRING_VALUE",
  },
};
const command = new CreateConfigurationSetTrackingOptionsCommand(input);
const response = await client.send(command);

Param

CreateConfigurationSetTrackingOptionsCommandInput

Returns

CreateConfigurationSetTrackingOptionsCommandOutput

See

• CreateConfigurationSetTrackingOptionsCommandInput for command's input shape.
• CreateConfigurationSetTrackingOptionsCommandOutput for command's response shape.
• config for SESClient's config shape.

Throws

ConfigurationSetDoesNotExistException (client fault)

Indicates that the configuration set does not exist.

Throws

InvalidTrackingOptionsException (client fault)

Indicates that the custom domain to be used for open and click tracking redirects is invalid. This error appears most often in the following situations:

• When the tracking domain you specified is not verified in Amazon SES.

• When the tracking domain you specified is not a valid domain or subdomain.

Throws

TrackingOptionsAlreadyExistsException (client fault)

Indicates that the configuration set you specified already contains a TrackingOptions object.