Package software.amazon.awssdk.services.sesv2.model

Interface EventDestination.Builder

    • Method Detail

      • name

        EventDestination.Builder name​(String name)

        A name that identifies the event destination.

        Parameters:
        name - A name that identifies the event destination.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enabled

        EventDestination.Builder enabled​(Boolean 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • matchingEventTypesWithStrings

        EventDestination.Builder matchingEventTypesWithStrings​(Collection<String> matchingEventTypes)

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

        • SEND - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)

        • REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to deliver it to the recipient’s mail server.

        • BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email. (Soft bounces are only included when SES fails to deliver the email after retrying for a period of time.)

        • COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient marked it as spam.

        • DELIVERY - SES successfully delivered the email to the recipient's mail server.

        • OPEN - The recipient received the message and opened it in their email client.

        • CLICK - The recipient clicked one or more links in the email.

        • RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data. (This event type only occurs when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail API operations.)

        • DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving email server experiences a transient issue.

        • SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an unsubscribe link as part of your subscription management.

        Parameters:
        matchingEventTypes - The types of events that Amazon SES sends to the specified event destinations.

        • SEND - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)

        • REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to deliver it to the recipient’s mail server.

        • BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email. (Soft bounces are only included when SES fails to deliver the email after retrying for a period of time.)

        • COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient marked it as spam.

        • DELIVERY - SES successfully delivered the email to the recipient's mail server.

        • OPEN - The recipient received the message and opened it in their email client.

        • CLICK - The recipient clicked one or more links in the email.

        • RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data. (This event type only occurs when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail API operations.)

        • DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving email server experiences a transient issue.

        • SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an unsubscribe link as part of your subscription management.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • matchingEventTypesWithStrings

        EventDestination.Builder matchingEventTypesWithStrings​(String... matchingEventTypes)

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

        • SEND - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)

        • REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to deliver it to the recipient’s mail server.

        • BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email. (Soft bounces are only included when SES fails to deliver the email after retrying for a period of time.)

        • COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient marked it as spam.

        • DELIVERY - SES successfully delivered the email to the recipient's mail server.

        • OPEN - The recipient received the message and opened it in their email client.

        • CLICK - The recipient clicked one or more links in the email.

        • RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data. (This event type only occurs when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail API operations.)

        • DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving email server experiences a transient issue.

        • SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an unsubscribe link as part of your subscription management.

        Parameters:
        matchingEventTypes - The types of events that Amazon SES sends to the specified event destinations.

        • SEND - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)

        • REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to deliver it to the recipient’s mail server.

        • BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email. (Soft bounces are only included when SES fails to deliver the email after retrying for a period of time.)

        • COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient marked it as spam.

        • DELIVERY - SES successfully delivered the email to the recipient's mail server.

        • OPEN - The recipient received the message and opened it in their email client.

        • CLICK - The recipient clicked one or more links in the email.

        • RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data. (This event type only occurs when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail API operations.)

        • DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving email server experiences a transient issue.

        • SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an unsubscribe link as part of your subscription management.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • matchingEventTypes

        EventDestination.Builder matchingEventTypes​(Collection<EventType> matchingEventTypes)

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

        • SEND - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)

        • REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to deliver it to the recipient’s mail server.

        • BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email. (Soft bounces are only included when SES fails to deliver the email after retrying for a period of time.)

        • COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient marked it as spam.

        • DELIVERY - SES successfully delivered the email to the recipient's mail server.

        • OPEN - The recipient received the message and opened it in their email client.

        • CLICK - The recipient clicked one or more links in the email.

        • RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data. (This event type only occurs when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail API operations.)

        • DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving email server experiences a transient issue.

        • SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an unsubscribe link as part of your subscription management.

        Parameters:
        matchingEventTypes - The types of events that Amazon SES sends to the specified event destinations.

        • SEND - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)

        • REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to deliver it to the recipient’s mail server.

        • BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email. (Soft bounces are only included when SES fails to deliver the email after retrying for a period of time.)

        • COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient marked it as spam.

        • DELIVERY - SES successfully delivered the email to the recipient's mail server.

        • OPEN - The recipient received the message and opened it in their email client.

        • CLICK - The recipient clicked one or more links in the email.

        • RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data. (This event type only occurs when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail API operations.)

        • DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving email server experiences a transient issue.

        • SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an unsubscribe link as part of your subscription management.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • matchingEventTypes

        EventDestination.Builder matchingEventTypes​(EventType... matchingEventTypes)

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

        • SEND - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)

        • REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to deliver it to the recipient’s mail server.

        • BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email. (Soft bounces are only included when SES fails to deliver the email after retrying for a period of time.)

        • COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient marked it as spam.

        • DELIVERY - SES successfully delivered the email to the recipient's mail server.

        • OPEN - The recipient received the message and opened it in their email client.

        • CLICK - The recipient clicked one or more links in the email.

        • RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data. (This event type only occurs when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail API operations.)

        • DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving email server experiences a transient issue.

        • SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an unsubscribe link as part of your subscription management.

        Parameters:
        matchingEventTypes - The types of events that Amazon SES sends to the specified event destinations.

        • SEND - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)

        • REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to deliver it to the recipient’s mail server.

        • BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email. (Soft bounces are only included when SES fails to deliver the email after retrying for a period of time.)

        • COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient marked it as spam.

        • DELIVERY - SES successfully delivered the email to the recipient's mail server.

        • OPEN - The recipient received the message and opened it in their email client.

        • CLICK - The recipient clicked one or more links in the email.

        • RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data. (This event type only occurs when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail API operations.)

        • DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving email server experiences a transient issue.

        • SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an unsubscribe link as part of your subscription management.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kinesisFirehoseDestination

        EventDestination.Builder kinesisFirehoseDestination​(KinesisFirehoseDestination kinesisFirehoseDestination)

        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.

        Parameters:
        kinesisFirehoseDestination - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cloudWatchDestination

        EventDestination.Builder cloudWatchDestination​(CloudWatchDestination cloudWatchDestination)

        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.

        Parameters:
        cloudWatchDestination - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snsDestination

        EventDestination.Builder snsDestination​(SnsDestination snsDestination)

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

        Parameters:
        snsDestination - An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notifications when certain email events occur.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • eventBridgeDestination

        EventDestination.Builder eventBridgeDestination​(EventBridgeDestination eventBridgeDestination)

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

        Parameters:
        eventBridgeDestination - An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to send notifications when certain email events occur.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • pinpointDestination

        EventDestination.Builder pinpointDestination​(PinpointDestination pinpointDestination)

        An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.

        Parameters:
        pinpointDestination - An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.