SESV2 / Client / get_contact

get_contact#

SESV2.Client.get_contact(**kwargs)#

Returns a contact from a contact list.

See also: AWS API Documentation

Request Syntax

response = client.get_contact(
    ContactListName='string',
    EmailAddress='string'
)
Parameters:

  • ContactListName (string) –

    [REQUIRED]

    The name of the contact list to which the contact belongs.

  • EmailAddress (string) –

    [REQUIRED]

    The contact’s email address.

Return type:

dict

Returns:

Response Syntax

{
    'ContactListName': 'string',
    'EmailAddress': 'string',
    'TopicPreferences': [
        {
            'TopicName': 'string',
            'SubscriptionStatus': 'OPT_IN'|'OPT_OUT'
        },
    ],
    'TopicDefaultPreferences': [
        {
            'TopicName': 'string',
            'SubscriptionStatus': 'OPT_IN'|'OPT_OUT'
        },
    ],
    'UnsubscribeAll': True|False,
    'AttributesData': 'string',
    'CreatedTimestamp': datetime(2015, 1, 1),
    'LastUpdatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • ContactListName (string) –

      The name of the contact list to which the contact belongs.

    • EmailAddress (string) –

      The contact’s email address.

    • TopicPreferences (list) –

      The contact’s preference for being opted-in to or opted-out of a topic.>

      • (dict) –

        The contact’s preference for being opted-in to or opted-out of a topic.

        • TopicName (string) –

          The name of the topic.

        • SubscriptionStatus (string) –

          The contact’s subscription status to a topic which is either OPT_IN or OPT_OUT.

    • TopicDefaultPreferences (list) –

      The default topic preferences applied to the contact.

      • (dict) –

        The contact’s preference for being opted-in to or opted-out of a topic.

        • TopicName (string) –

          The name of the topic.

        • SubscriptionStatus (string) –

          The contact’s subscription status to a topic which is either OPT_IN or OPT_OUT.

    • UnsubscribeAll (boolean) –

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

    • AttributesData (string) –

      The attribute data attached to a contact.

    • CreatedTimestamp (datetime) –

      A timestamp noting when the contact was created.

    • LastUpdatedTimestamp (datetime) –

      A timestamp noting the last time the contact’s information was updated.

Exceptions