PinpointEmail / Client / get_configuration_set_event_destinations

get_configuration_set_event_destinations#

PinpointEmail.Client.get_configuration_set_event_destinations(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.get_configuration_set_event_destinations(
    ConfigurationSetName='string'
)
Parameters:

ConfigurationSetName (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'EventDestinations': [
        {
            'Name': 'string',
            'Enabled': True|False,
            'MatchingEventTypes': [
                'SEND'|'REJECT'|'BOUNCE'|'COMPLAINT'|'DELIVERY'|'OPEN'|'CLICK'|'RENDERING_FAILURE',
            ],
            'KinesisFirehoseDestination': {
                'IamRoleArn': 'string',
                'DeliveryStreamArn': 'string'
            },
            'CloudWatchDestination': {
                'DimensionConfigurations': [
                    {
                        'DimensionName': 'string',
                        'DimensionValueSource': 'MESSAGE_TAG'|'EMAIL_HEADER'|'LINK_TAG',
                        'DefaultDimensionValue': 'string'
                    },
                ]
            },
            'SnsDestination': {
                'TopicArn': 'string'
            },
            'PinpointDestination': {
                'ApplicationArn': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) –

    Information about an event destination for a configuration set.

    • EventDestinations (list) –

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

      • (dict) –

        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 (string) –

          A name that identifies the event destination.

        • Enabled (boolean) –

          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.

        • MatchingEventTypes (list) –

          The types of events that Amazon Pinpoint sends to the specified event destinations.

          • (string) –

            An email sending event type. For example, email sends, opens, and bounces are all email events.

        • KinesisFirehoseDestination (dict) –

          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.

          • IamRoleArn (string) –

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

          • DeliveryStreamArn (string) –

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

        • CloudWatchDestination (dict) –

          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.

          • DimensionConfigurations (list) –

            An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.

            • (dict) –

              An object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.

              • DimensionName (string) –

                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.

              • DimensionValueSource (string) –

                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.

              • DefaultDimensionValue (string) –

                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.

        • SnsDestination (dict) –

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

          • TopicArn (string) –

            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.

        • PinpointDestination (dict) –

          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.

          • ApplicationArn (string) –

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

Exceptions