Skip to content

aws.sesv2.get_contact_list

Example SQL Queries

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

Description

Returns contact list metadata. It does not return any information about the contacts present in the list.

Table Definition

Column NameColumn Data Type
contact_list_name Required Input Column

The name of the contact list.

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.

created_timestamp

A timestamp noting when the contact list was created.

TIMESTAMP_S
description

A description of what the contact list is about.

VARCHAR
last_updated_timestamp

A timestamp noting the last time the contact list was updated.

TIMESTAMP_S
tags

The tags associated with a contact list.

STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
Show child fields
tags[]
Show child fields
tags[].key

One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

tags[].value

The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want a resource to have a specific tag value, don't specify a value for this parameter. If you don't specify a value, Amazon SES sets the value to an empty string.

topics

An interest group, theme, or label within a list. A contact list can have multiple topics.

STRUCT(
"topic_name" VARCHAR,
"display_name" VARCHAR,
"description" VARCHAR,
"default_subscription_status" VARCHAR
)[]
Show child fields
topics[]
Show child fields
topics[].default_subscription_status

The default subscription status to be applied to a contact if the contact has not noted their preference for subscribing to a topic.

topics[].description

A description of what the topic is about, which the contact will see.

topics[].display_name

The name of the topic the contact will see.

topics[].topic_name

The name of the topic.