Skip to content
AWS for Query.Farm

aws.pinpoint_email.get_configuration_set_event_destinations

Example SQL Queries

SELECT * FROM
aws.pinpoint_email.get_configuration_set_event_destinations
WHERE
"configuration_set_name" = 'VALUE';

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.

Table Definition

Column NameColumn Data Type
configuration_set_name Required Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

event_destinations

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

STRUCT(
    "name" VARCHAR,
    "enabled" BOOLEAN,
    "matching_event_types" VARCHAR[],
    "kinesis_firehose_destination" STRUCT(
        "iam_role_arn" VARCHAR,
        "delivery_stream_arn" VARCHAR
    ),
    "cloud_watch_destination" STRUCT(
        "dimension_configurations" STRUCT(
            "dimension_name" VARCHAR,
            "dimension_value_source" VARCHAR,
            "default_dimension_value" VARCHAR
        )[]
    ),
    "sns_destination" STRUCT(
        "topic_arn" VARCHAR
    ),
    "pinpoint_destination" STRUCT(
        "application_arn" VARCHAR
    )
)[]
Show child fields
event_destinations[]
Show child fields
event_destinations[].cloud_watch_destination

An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

Show child fields
event_destinations[].cloud_watch_destination.dimension_configurations[]
Show child fields
event_destinations[].cloud_watch_destination.dimension_configurations[].default_dimension_value

The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:

  • It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • It can contain no more than 256 characters.

event_destinations[].cloud_watch_destination.dimension_configurations[].dimension_name

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:

  • It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • It can contain no more than 256 characters.

event_destinations[].cloud_watch_destination.dimension_configurations[].dimension_value_source

The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.

event_destinations[].enabled

If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.

If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.

event_destinations[].kinesis_firehose_destination

An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.

Show child fields
event_destinations[].kinesis_firehose_destination.delivery_stream_arn

The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.

event_destinations[].kinesis_firehose_destination.iam_role_arn

The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.

event_destinations[].matching_event_types[]
event_destinations[].name

A name that identifies the event destination.

event_destinations[].pinpoint_destination

An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.

Show child fields
event_destinations[].pinpoint_destination.application_arn

The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.

event_destinations[].sns_destination

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

Show child fields
event_destinations[].sns_destination.topic_arn

The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.