GetConfigurationSetEventDestinations - Amazon Pinpoint Email Service

GetConfigurationSetEventDestinations

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.

Request Syntax

GET /v1/email/configuration-sets/ConfigurationSetName/event-destinations HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ConfigurationSetName

The name of the configuration set that contains the event destination.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "EventDestinations": [ { "CloudWatchDestination": { "DimensionConfigurations": [ { "DefaultDimensionValue": "string", "DimensionName": "string", "DimensionValueSource": "string" } ] }, "Enabled": boolean, "KinesisFirehoseDestination": { "DeliveryStreamArn": "string", "IamRoleArn": "string" }, "MatchingEventTypes": [ "string" ], "Name": "string", "PinpointDestination": { "ApplicationArn": "string" }, "SnsDestination": { "TopicArn": "string" } } ] }

Response Elements

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

The following data is returned in JSON format by the service.

EventDestinations

An array that includes all of the events destinations that have been configured for the configuration set.

Type: Array of EventDestination objects

Errors

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

BadRequestException

The input you provided is invalid.

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: