Skip to content
AWS for Query.Farm

aws.sesv2.list_contacts

Example SQL Queries

SELECT * FROM
aws.sesv2.list_contacts
WHERE
"contact_list_name" = 'VALUE';

Description

Lists the contacts present in a specific contact list.

Table Definition

Column NameColumn Data Type
contact_list_name Required Input Column

The name of the contact list.

VARCHAR
filter Input Column

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

STRUCT(
    "filtered_status" VARCHAR,
    "topic_filter" STRUCT(
        "topic_name" VARCHAR,
        "use_default_if_preference_unavailable" BOOLEAN
    )
)
Show child fields
filter.filtered_status

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

filter.topic_filter

Used for filtering by a specific topic preference.

Show child fields
filter.topic_filter.topic_name

The name of a topic on which you wish to apply the filter.

filter.topic_filter.use_default_if_preference_unavailable

Notes that the default subscription status should be applied to a contact because the contact has not noted their preference for subscribing to a topic.

next_token Input Column

A string token indicating that there might be additional contacts available to be listed. Copy this token to a subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

VARCHAR
page_size Input Column

The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts.

BIGINT
_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.

contacts

The contacts present in a specific contact list.

STRUCT(
    "email_address" VARCHAR,
    "topic_preferences" STRUCT(
        "topic_name" VARCHAR,
        "subscription_status" VARCHAR
    )[],
    "topic_default_preferences" STRUCT(
        "topic_name" VARCHAR,
        "subscription_status" VARCHAR
    )[],
    "unsubscribe_all" BOOLEAN,
    "last_updated_timestamp" TIMESTAMP_S
)[]
Show child fields
contacts[]
Show child fields
contacts[].email_address

The contact's email address.

contacts[].last_updated_timestamp

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

contacts[].topic_default_preferences[]
Show child fields
contacts[].topic_default_preferences[].subscription_status

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

contacts[].topic_default_preferences[].topic_name

The name of the topic.

contacts[].topic_preferences[]
Show child fields
contacts[].topic_preferences[].subscription_status

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

contacts[].topic_preferences[].topic_name

The name of the topic.

contacts[].unsubscribe_all

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