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 UpdateConfigurationSetEventDestinationCommandProtected

Update the configuration of an event destination for a configuration set.

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

Example

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

import { PinpointEmailClient, UpdateConfigurationSetEventDestinationCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import
// const { PinpointEmailClient, UpdateConfigurationSetEventDestinationCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import
const client = new PinpointEmailClient(config);
const input = { // UpdateConfigurationSetEventDestinationRequest
ConfigurationSetName: "STRING_VALUE", // required
EventDestinationName: "STRING_VALUE", // required
EventDestination: { // EventDestinationDefinition
Enabled: true || false,
MatchingEventTypes: [ // EventTypes
"STRING_VALUE",
],
KinesisFirehoseDestination: { // KinesisFirehoseDestination
IamRoleArn: "STRING_VALUE", // required
DeliveryStreamArn: "STRING_VALUE", // required
},
CloudWatchDestination: { // CloudWatchDestination
DimensionConfigurations: [ // CloudWatchDimensionConfigurations // required
{ // CloudWatchDimensionConfiguration
DimensionName: "STRING_VALUE", // required
DimensionValueSource: "STRING_VALUE", // required
DefaultDimensionValue: "STRING_VALUE", // required
},
],
},
SnsDestination: { // SnsDestination
TopicArn: "STRING_VALUE", // required
},
PinpointDestination: { // PinpointDestination
ApplicationArn: "STRING_VALUE",
},
},
};
const command = new UpdateConfigurationSetEventDestinationCommand(input);
const response = await client.send(command);
// {};

Param

UpdateConfigurationSetEventDestinationCommandInput

Returns

UpdateConfigurationSetEventDestinationCommandOutput

See

Throws

BadRequestException (client fault)

The input you provided is invalid.

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