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

Class: Aws::SESV2::Types::CreateContactRequest

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

Overview

Note:

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

{
  contact_list_name: "ContactListName", # required
  email_address: "EmailAddress", # required
  topic_preferences: [
    {
      topic_name: "TopicName", # required
      subscription_status: "OPT_IN", # required, accepts OPT_IN, OPT_OUT
    },
  ],
  unsubscribe_all: false,
  attributes_data: "AttributesData",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attributes_data ⇒ String

The attribute data attached to a contact.

Returns:

  • (String) —

    The attribute data attached to a contact.

#contact_list_name ⇒ String

The name of the contact list to which the contact should be added.

Returns:

  • (String) —

    The name of the contact list to which the contact should be added.

#email_address ⇒ String

The contact\'s email address.

Returns:

  • (String) —

    The contact\'s email address.

#topic_preferences ⇒ Array<Types::TopicPreference>

The contact\'s preferences for being opted-in to or opted-out of topics.

Returns:

  • (Array<Types::TopicPreference>) —

    The contact\'s preferences for being opted-in to or opted-out of topics.

#unsubscribe_all ⇒ Boolean

A boolean value status noting if the contact is unsubscribed from all contact list topics.

Returns:

  • (Boolean) —

    A boolean value status noting if the contact is unsubscribed from all contact list topics.