Get Configuration Set Event Destinations

pinpointemail_get_configuration_set_event_destinations

R Documentation

Retrieve a list of event destinations that are associated with a configuration set

Description

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.

Usage

pinpointemail_get_configuration_set_event_destinations(
  ConfigurationSetName)

Arguments

ConfigurationSetName

[required] The name of the configuration set that contains the event destination.

Value

A list with the following syntax:

list(
  EventDestinations = list(
    list(
      Name = "string",
      Enabled = TRUE|FALSE,
      MatchingEventTypes = list(
        "SEND"|"REJECT"|"BOUNCE"|"COMPLAINT"|"DELIVERY"|"OPEN"|"CLICK"|"RENDERING_FAILURE"
      ),
      KinesisFirehoseDestination = list(
        IamRoleArn = "string",
        DeliveryStreamArn = "string"
      ),
      CloudWatchDestination = list(
        DimensionConfigurations = list(
          list(
            DimensionName = "string",
            DimensionValueSource = "MESSAGE_TAG"|"EMAIL_HEADER"|"LINK_TAG",
            DefaultDimensionValue = "string"
          )
        )
      ),
      SnsDestination = list(
        TopicArn = "string"
      ),
      PinpointDestination = list(
        ApplicationArn = "string"
      )
    )
  )
)

Request syntax

svc$get_configuration_set_event_destinations(
  ConfigurationSetName = "string"
)