Skip to content
AWS for Query.Farm

aws.sesv2.get_contact

Example SQL Queries

SELECT * FROM
aws.sesv2.get_contact
WHERE
"contact_list_name" = 'VALUE'
AND "email_address" = 'VALUE';

Description

Returns a contact from a contact list.

Table Definition

Column NameColumn Data Type
contact_list_name Required Input Column

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

VARCHAR
email_address Required Input Column

The contact's email address.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

attributes_data

The attribute data attached to a contact.

VARCHAR
created_timestamp

A timestamp noting when the contact was created.

TIMESTAMP_S
last_updated_timestamp

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

TIMESTAMP_S
topic_default_preferences

The default topic preferences applied to the contact.

STRUCT(
    "topic_name" VARCHAR,
    "subscription_status" VARCHAR
)[]
Show child fields
topic_default_preferences[]
Show child fields
topic_default_preferences[].subscription_status

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

topic_default_preferences[].topic_name

The name of the topic.

topic_preferences

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

STRUCT(
    "topic_name" VARCHAR,
    "subscription_status" VARCHAR
)[]
Show child fields
topic_preferences[]
Show child fields
topic_preferences[].subscription_status

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

topic_preferences[].topic_name

The name of the topic.

unsubscribe_all

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

BOOLEAN