configuration_set_event_destinations

Creates, updates, deletes, gets or lists a configuration_set_event_destinations resource.

Overview

Name	configuration_set_event_destinations
Type	Resource
Id	aws.pinpoint_email.configuration_set_event_destinations

Fields

The following fields are returned by SELECT queries:

get_configuration_set_event_destinations

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_configuration_set_event_destinations	select	configuration_set_name, region		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.
create_configuration_set_event_destination	insert	configuration_set_name, region, EventDestinationName, EventDestination		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.
update_configuration_set_event_destination	update	configuration_set_name, event_destination_name, region, EventDestination		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.
delete_configuration_set_event_destination	delete	configuration_set_name, event_destination_name, region		Delete 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
configuration_set_name	string	The name of the configuration set that contains the event destination that you want to delete.
event_destination_name	string	The name of the event destination that you want to delete.
region	string	AWS region (default: us-east-1)

SELECT examples

get_configuration_set_event_destinations

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.

SELECT
event_destinations
FROM aws.pinpoint_email.configuration_set_event_destinations
WHERE configuration_set_name = '{{ configuration_set_name }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_configuration_set_event_destination

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.

INSERT INTO aws.pinpoint_email.configuration_set_event_destinations (
EventDestinationName,
EventDestination,
configuration_set_name,
region
)
SELECT 
'{{ EventDestinationName }}' /* required */,
'{{ EventDestination }}' /* required */,
'{{ configuration_set_name }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: configuration_set_event_destinations
props:
  - name: configuration_set_name
    value: "{{ configuration_set_name }}"
    description: Required parameter for the configuration_set_event_destinations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the configuration_set_event_destinations resource.
  - name: EventDestinationName
    value: "{{ EventDestinationName }}"
    description: |
      The name of 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.
  - name: EventDestination
    description: |
      An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination.
    value:
      Enabled: {{ Enabled }}
      MatchingEventTypes:
        - "{{ MatchingEventTypes }}"
      KinesisFirehoseDestination:
        IamRoleArn: "{{ IamRoleArn }}"
        DeliveryStreamArn: "{{ DeliveryStreamArn }}"
      CloudWatchDestination:
        DimensionConfigurations:
          - DimensionName: "{{ DimensionName }}"
            DimensionValueSource: "{{ DimensionValueSource }}"
            DefaultDimensionValue: "{{ DefaultDimensionValue }}"
      SnsDestination:
        TopicArn: "{{ TopicArn }}"
      PinpointDestination:
        ApplicationArn: "{{ ApplicationArn }}"

UPDATE examples

update_configuration_set_event_destination

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.

UPDATE aws.pinpoint_email.configuration_set_event_destinations
SET 
EventDestination = '{{ EventDestination }}'
WHERE 
configuration_set_name = '{{ configuration_set_name }}' --required
AND event_destination_name = '{{ event_destination_name }}' --required
AND region = '{{ region }}' --required
AND EventDestination = '{{ EventDestination }}' --required;

DELETE examples

delete_configuration_set_event_destination

Delete 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.

DELETE FROM aws.pinpoint_email.configuration_set_event_destinations
WHERE configuration_set_name = '{{ configuration_set_name }}' --required
AND event_destination_name = '{{ event_destination_name }}' --required
AND region = '{{ region }}' --required
;