Class GetConfigurationSetEventDestinationsCommandProtected

Retrieve a list of event destinations that are associated with 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, GetConfigurationSetEventDestinationsCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import
// const { PinpointEmailClient, GetConfigurationSetEventDestinationsCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import
const client = new PinpointEmailClient(config);
const input = { // GetConfigurationSetEventDestinationsRequest
  ConfigurationSetName: "STRING_VALUE", // required
};
const command = new GetConfigurationSetEventDestinationsCommand(input);
const response = await client.send(command);
// { // GetConfigurationSetEventDestinationsResponse
//   EventDestinations: [ // EventDestinations
//     { // EventDestination
//       Name: "STRING_VALUE", // required
//       Enabled: true || false,
//       MatchingEventTypes: [ // EventTypes // required
//         "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",
//       },
//     },
//   ],
// };

Param

GetConfigurationSetEventDestinationsCommandInput

Returns

GetConfigurationSetEventDestinationsCommandOutput

See

• GetConfigurationSetEventDestinationsCommandInput for command's input shape.
• GetConfigurationSetEventDestinationsCommandOutput for command's response shape.
• config for PinpointEmailClient's config shape.

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.