Skip to content
AWS for Query.Farm

aws.ses.describe_configuration_set

Example SQL Queries

SELECT * FROM
aws.ses.describe_configuration_set
WHERE
"configuration_set_name" = 'VALUE';

Description

Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Table Definition

Column NameColumn Data Type
configuration_set_name Required Input Column

The name of the configuration set to describe.

VARCHAR
configuration_set_attribute_names Input Column

A list of configuration set attributes to return.

VARCHAR[]
Show child fields
configuration_set_attribute_names[]
_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.

configuration_set

The configuration set object associated with the specified configuration set.

STRUCT(
    "name" VARCHAR
)
Show child fields
configuration_set.name

The name of the configuration set. The name must meet the following requirements:

  • Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Contain 64 characters or fewer.

delivery_options

Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).

STRUCT(
    "tls_policy" VARCHAR
)
Show child fields
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.

event_destinations

A list of event destinations associated with the configuration set. 

STRUCT(
    "name" VARCHAR,
    "enabled" BOOLEAN,
    "matching_event_types" VARCHAR[],
    "kinesis_firehose_destination" STRUCT(
        "iam_role_arn" VARCHAR,
        "delivery_stream_arn" VARCHAR
    ),
    "cloud_watch_destination" STRUCT(
        "dimension_configurations" STRUCT(
            "dimension_name" VARCHAR,
            "dimension_value_source" VARCHAR,
            "default_dimension_value" VARCHAR
        )[]
    ),
    "sns_destination" STRUCT(
        "topic_arn" VARCHAR
    )
)[]
Show child fields
event_destinations[]
Show child fields
event_destinations[].cloud_watch_destination

An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.

Show child fields
event_destinations[].cloud_watch_destination.dimension_configurations[]
Show child fields
event_destinations[].cloud_watch_destination.dimension_configurations[].default_dimension_value

The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), at signs (@), or periods (.).

  • Contain 256 characters or fewer.

event_destinations[].cloud_watch_destination.dimension_configurations[].dimension_name

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or colons (:).

  • Contain 256 characters or fewer.

event_destinations[].cloud_watch_destination.dimension_configurations[].dimension_value_source

The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, specify messageTag. To use your own email headers, specify emailHeader. To put a custom tag on any link included in your email, specify linkTag.

event_destinations[].enabled

Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false.

event_destinations[].kinesis_firehose_destination

An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

Show child fields
event_destinations[].kinesis_firehose_destination.delivery_stream_arn

The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.

event_destinations[].kinesis_firehose_destination.iam_role_arn

The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.

event_destinations[].matching_event_types[]
event_destinations[].name

The name of the event destination. The name must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Contain 64 characters or fewer.

event_destinations[].sns_destination

An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

Show child fields
event_destinations[].sns_destination.topic_arn

The ARN of the Amazon SNS topic for email sending events. You can find the ARN of a topic by using the ListTopics Amazon SNS operation.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

reputation_options

An object that represents the reputation settings for the configuration set. 

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

The date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.

When you disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled and later re-enable it, the reputation metrics for the configuration set (but not for the entire Amazon SES account) are reset.

If email sending for the configuration set has never been disabled and later re-enabled, the value of this attribute is null.

reputation_options.reputation_metrics_enabled

Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.

If the value is true, reputation metrics are published. If the value is false, reputation metrics are not published. The default value is false.

reputation_options.sending_enabled

Describes whether email sending is enabled or disabled for the configuration set. If the value is true, then Amazon SES sends emails that use the configuration set. If the value is false, Amazon SES does not send emails that use the configuration set. The default value is true. You can change this setting using UpdateConfigurationSetSendingEnabled.

tracking_options

The name of the custom open and click tracking domain associated with the configuration set.

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

The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.