You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SESV2::Types::ListSuppressedDestinationsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListSuppressedDestinationsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  reasons: ["BOUNCE"], # accepts BOUNCE, COMPLAINT
  start_date: Time.now,
  end_date: Time.now,
  next_token: "NextToken",
  page_size: 1,
}

A request to obtain a list of email destinations that are on the suppression list for your account.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#end_date ⇒ Time

Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date. The date that you specify should be in Unix time format.

Returns:

  • (Time) —

    Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date.

#next_token ⇒ String

A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.

Returns:

  • (String) —

    A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.

#page_size ⇒ Integer

The number of results to show in a single call to ListSuppressedDestinations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

Returns:

  • (Integer) —

    The number of results to show in a single call to ListSuppressedDestinations.

#reasons ⇒ Array<String>

The factors that caused the email address to be added to .

Returns:

  • (Array<String>) —

    The factors that caused the email address to be added to .

#start_date ⇒ Time

Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date. The date that you specify should be in Unix time format.

Returns:

  • (Time) —

    Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date.