UpdateConfigurationSetEventDestinationCommand

Suggest an Edit

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 Syntax

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
      "SEND" || "REJECT" || "BOUNCE" || "COMPLAINT" || "DELIVERY" || "OPEN" || "CLICK" || "RENDERING_FAILURE",
    ],
    KinesisFirehoseDestination: { // KinesisFirehoseDestination
      IamRoleArn: "STRING_VALUE", // required
      DeliveryStreamArn: "STRING_VALUE", // required
    },
    CloudWatchDestination: { // CloudWatchDestination
      DimensionConfigurations: [ // CloudWatchDimensionConfigurations // required
        { // CloudWatchDimensionConfiguration
          DimensionName: "STRING_VALUE", // required
          DimensionValueSource: "MESSAGE_TAG" || "EMAIL_HEADER" || "LINK_TAG", // 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);
// {};

UpdateConfigurationSetEventDestinationCommand Input

See UpdateConfigurationSetEventDestinationCommandInput for more details

Parameter
Type
Description
ConfigurationSetName
Required
string | undefined

The name of the configuration set that contains the event destination that you want to modify.

EventDestination
Required
EventDestinationDefinition | undefined

An object that defines the event destination.

EventDestinationName
Required
string | undefined

The name of the event destination that you want to modify.

UpdateConfigurationSetEventDestinationCommand Output

See UpdateConfigurationSetEventDestinationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
BadRequestException
client

The input you provided is invalid.

NotFoundException
client

The resource you attempted to access doesn't exist.

TooManyRequestsException
client

Too many requests have been made to the operation.

PinpointEmailServiceException
Base exception class for all service exceptions from PinpointEmail service.