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

Class: Aws::SESV2::Types::ListContactsFilter

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

Overview

Note:

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

{
  filtered_status: "OPT_IN", # accepts OPT_IN, OPT_OUT
  topic_filter: {
    topic_name: "TopicName",
    use_default_if_preference_unavailable: false,
  },
}

A filter that can be applied to a list of contacts.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#filtered_status ⇒ String

The status by which you are filtering: OPT_IN or OPT_OUT.

Possible values:

  • OPT_IN
  • OPT_OUT

Returns:

  • (String) —

    The status by which you are filtering: OPT_IN or OPT_OUT.

#topic_filter ⇒ Types::TopicFilter

Used for filtering by a specific topic preference.

Returns: