Amazon Pinpoint Email Service
API Reference (API Version 2018-07-26)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

CreateConfigurationSetEventDestination

Create an event destination. 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.

A single configuration set can include more than one event destination.

Request Syntax

POST /v1/email/configuration-sets/ConfigurationSetName/event-destinations HTTP/1.1 Content-type: application/json { "EventDestination": { "CloudWatchDestination": { "DimensionConfigurations": [ { "DefaultDimensionValue": "string", "DimensionName": "string", "DimensionValueSource": "string" } ] }, "Enabled": boolean, "KinesisFirehoseDestination": { "DeliveryStreamArn": "string", "IamRoleArn": "string" }, "MatchingEventTypes": [ "string" ], "PinpointDestination": { "ApplicationArn": "string" }, "SnsDestination": { "TopicArn": "string" } }, "EventDestinationName": "string" }

URI Request Parameters

The request requires the following URI parameters.

ConfigurationSetName

The name of the configuration set that you want to add an event destination to.

Request Body

The request accepts the following data in JSON format.

EventDestination

An object that defines the event destination.

Type: EventDestinationDefinition object

Required: Yes

EventDestinationName

A name that identifies the event destination within the configuration set.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AlreadyExistsException

The resource specified in your request already exists.

HTTP Status Code: 400

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

LimitExceededException

There are too many instances of the specified resource type.

HTTP Status Code: 400

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: