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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb

Overview

Note:

When making an API call, you may pass CreateContactRequest data as a 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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributes_dataString

The attribute data attached to a contact.

Returns:

  • (String)


778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 778

class CreateContactRequest < Struct.new(
  :contact_list_name,
  :email_address,
  :topic_preferences,
  :unsubscribe_all,
  :attributes_data)
  SENSITIVE = []
  include Aws::Structure
end

#contact_list_nameString

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

Returns:

  • (String)


778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 778

class CreateContactRequest < Struct.new(
  :contact_list_name,
  :email_address,
  :topic_preferences,
  :unsubscribe_all,
  :attributes_data)
  SENSITIVE = []
  include Aws::Structure
end

#email_addressString

The contact's email address.

Returns:

  • (String)


778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 778

class CreateContactRequest < Struct.new(
  :contact_list_name,
  :email_address,
  :topic_preferences,
  :unsubscribe_all,
  :attributes_data)
  SENSITIVE = []
  include Aws::Structure
end

#topic_preferencesArray<Types::TopicPreference>

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

Returns:



778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 778

class CreateContactRequest < Struct.new(
  :contact_list_name,
  :email_address,
  :topic_preferences,
  :unsubscribe_all,
  :attributes_data)
  SENSITIVE = []
  include Aws::Structure
end

#unsubscribe_allBoolean

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

Returns:

  • (Boolean)


778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 778

class CreateContactRequest < Struct.new(
  :contact_list_name,
  :email_address,
  :topic_preferences,
  :unsubscribe_all,
  :attributes_data)
  SENSITIVE = []
  include Aws::Structure
end