Class: Aws::SES::Types::EventDestination

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ses/types.rb

Overview

Contains information about an event destination.

<note markdown=“1”> When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).

</note>

Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see the [Amazon SES Developer Guide].

[1]: docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_destination ⇒ Types::CloudWatchDestination

An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.

Returns:



1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/aws-sdk-ses/types.rb', line 1526

class EventDestination < Struct.new(
  :name,
  :enabled,
  :matching_event_types,
  :kinesis_firehose_destination,
  :cloud_watch_destination,
  :sns_destination)
  SENSITIVE = []
  include Aws::Structure
end

#enabled ⇒ Boolean

Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to ‘true` to enable publishing to this destination; set to `false` to prevent publishing to this destination. The default value is `false`.

Returns:

  • (Boolean) 


1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/aws-sdk-ses/types.rb', line 1526

class EventDestination < Struct.new(
  :name,
  :enabled,
  :matching_event_types,
  :kinesis_firehose_destination,
  :cloud_watch_destination,
  :sns_destination)
  SENSITIVE = []
  include Aws::Structure
end

#kinesis_firehose_destination ⇒ Types::KinesisFirehoseDestination

An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

Returns:



1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/aws-sdk-ses/types.rb', line 1526

class EventDestination < Struct.new(
  :name,
  :enabled,
  :matching_event_types,
  :kinesis_firehose_destination,
  :cloud_watch_destination,
  :sns_destination)
  SENSITIVE = []
  include Aws::Structure
end

#matching_event_types ⇒ Array<String>

The type of email sending events to publish to the event destination.

  • ‘send` - The call was successful and Amazon SES is attempting to deliver the email.

  • ‘reject` - Amazon SES determined that the email contained a virus and rejected it.

  • ‘bounce` - The recipient’s mail server permanently rejected the email. This corresponds to a hard bounce.

  • ‘complaint` - The recipient marked the email as spam.

  • ‘delivery` - Amazon SES successfully delivered the email to the recipient’s mail server.

  • ‘open` - The recipient received the email and opened it in their email client.

  • ‘click` - The recipient clicked one or more links in the email.

  • ‘renderingFailure` - Amazon SES did not send the email because of a template rendering issue.

Returns:

  • (Array<String>) 


1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/aws-sdk-ses/types.rb', line 1526

class EventDestination < Struct.new(
  :name,
  :enabled,
  :matching_event_types,
  :kinesis_firehose_destination,
  :cloud_watch_destination,
  :sns_destination)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the event destination. The name must meet the following requirements:

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

  • Contain 64 characters or fewer.

Returns:

  • (String) 


1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/aws-sdk-ses/types.rb', line 1526

class EventDestination < Struct.new(
  :name,
  :enabled,
  :matching_event_types,
  :kinesis_firehose_destination,
  :cloud_watch_destination,
  :sns_destination)
  SENSITIVE = []
  include Aws::Structure
end

#sns_destination ⇒ Types::SNSDestination

An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

Returns:



1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/aws-sdk-ses/types.rb', line 1526

class EventDestination < Struct.new(
  :name,
  :enabled,
  :matching_event_types,
  :kinesis_firehose_destination,
  :cloud_watch_destination,
  :sns_destination)
  SENSITIVE = []
  include Aws::Structure
end