Skip to content
AWS for Query.Farm

aws.sesv2.get_configuration_set

Example SQL Queries

SELECT * FROM
aws.sesv2.get_configuration_set
WHERE
"configuration_set_name" = 'VALUE';

Description

Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.

Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Table Definition

Column NameColumn Data Type
configuration_set_name Required Input Column

The name of the configuration set.

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.

delivery_options

An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

STRUCT(
    "tls_policy" VARCHAR,
    "sending_pool_name" VARCHAR
)
Show child fields
delivery_options.sending_pool_name

The name of the dedicated IP pool to associate with the configuration set.

delivery_options.tls_policy

Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.

reputation_options

An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.

STRUCT(
    "reputation_metrics_enabled" BOOLEAN,
    "last_fresh_start" TIMESTAMP_S
)
Show child fields
reputation_options.last_fresh_start

The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.

reputation_options.reputation_metrics_enabled

If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.

sending_options

An object that defines whether or not Amazon SES can send email that you send using the configuration set.

STRUCT(
    "sending_enabled" BOOLEAN
)
Show child fields
sending_options.sending_enabled

If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.

suppression_options

An object that contains information about the suppression list preferences for your account.

STRUCT(
    "suppressed_reasons" VARCHAR[]
)
Show child fields
suppression_options.suppressed_reasons[]
tags

An array of objects that define the tags (keys and values) that are associated with the configuration set.

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.

tracking_options

An object that defines the open and click tracking options for emails that you send using the configuration set.

STRUCT(
    "custom_redirect_domain" VARCHAR
)
Show child fields
tracking_options.custom_redirect_domain

The domain to use for tracking open and click events.

vdm_options

An object that contains information about the VDM preferences for your configuration set.

STRUCT(
    "dashboard_options" STRUCT(
        "engagement_metrics" VARCHAR
    ),
    "guardian_options" STRUCT(
        "optimized_shared_delivery" VARCHAR
    )
)
Show child fields
vdm_options.dashboard_options

Specifies additional settings for your VDM configuration as applicable to the Dashboard.

Show child fields
vdm_options.dashboard_options.engagement_metrics

Specifies the status of your VDM engagement metrics collection. Can be one of the following:

  • ENABLED – Amazon SES enables engagement metrics for the configuration set.

  • DISABLED – Amazon SES disables engagement metrics for the configuration set.

vdm_options.guardian_options

Specifies additional settings for your VDM configuration as applicable to the Guardian.

Show child fields
vdm_options.guardian_options.optimized_shared_delivery

Specifies the status of your VDM optimized shared delivery. Can be one of the following:

  • ENABLED – Amazon SES enables optimized shared delivery for the configuration set.

  • DISABLED – Amazon SES disables optimized shared delivery for the configuration set.