Skip to content

aws.sesv2.get_email_identity

Example SQL Queries

SELECT * FROM
aws.sesv2.get_email_identity
WHERE
"email_identity" = 'VALUE';

Description

Provides information about a specific identity, including the identity's verification status, sending authorization policies, its DKIM authentication status, and its custom Mail-From settings.

Table Definition

Column NameColumn Data Type
email_identity Required Input Column

The email identity.

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.

configuration_set_name

The configuration set used by default when sending from this identity.

VARCHAR
dkim_attributes

An object that contains information about the DKIM attributes for the identity.

STRUCT(
"signing_enabled" BOOLEAN,
"status" VARCHAR,
"tokens" VARCHAR[],
"signing_attributes_origin" VARCHAR,
"next_signing_key_length" VARCHAR,
"current_signing_key_length" VARCHAR,
"last_key_generation_timestamp" TIMESTAMP_S
)
Show child fields
dkim_attributes.current_signing_key_length

[Easy DKIM] The key length of the DKIM key pair in use.

dkim_attributes.last_key_generation_timestamp

[Easy DKIM] The last time a key pair was generated for this identity.

dkim_attributes.next_signing_key_length

[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.

dkim_attributes.signing_attributes_origin

A string that indicates how DKIM was configured for the identity. These are the possible values:

  • AWS_SES – Indicates that DKIM was configured for the identity by using Easy DKIM.

  • EXTERNAL – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).

dkim_attributes.signing_enabled

If the value is true, then the messages that you send from the identity are signed using DKIM. If the value is false, then the messages that you send from the identity aren't DKIM-signed.

dkim_attributes.status

Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:

  • PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.

  • SUCCESS – The verification process completed successfully.

  • FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.

  • TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.

  • NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.

dkim_attributes.tokens[]
feedback_forwarding_status

The feedback forwarding configuration for the identity.

If the value is true, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email.

You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).

BOOLEAN
identity_type

The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.

VARCHAR
mail_from_attributes

An object that contains information about the Mail-From attributes for the email identity.

STRUCT(
"mail_from_domain" VARCHAR,
"mail_from_domain_status" VARCHAR,
"behavior_on_mx_failure" VARCHAR
)
Show child fields
mail_from_attributes.behavior_on_mx_failure

The action to take if the required MX record can't be found when you send an email. When you set this value to USE_DEFAULT_VALUE, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to REJECT_MESSAGE, the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.

mail_from_attributes.mail_from_domain

The name of a domain that an email identity uses as a custom MAIL FROM domain.

mail_from_attributes.mail_from_domain_status

The status of the MAIL FROM domain. This status can have the following values:

  • PENDING – Amazon SES hasn't started searching for the MX record yet.

  • SUCCESS – Amazon SES detected the required MX record for the MAIL FROM domain.

  • FAILED – Amazon SES can't find the required MX record, or the record no longer exists.

  • TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.

policies

A map of policy names to policies.

MAP(VARCHAR, VARCHAR)
tags

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

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.

verification_info

An object that contains additional information about the verification status for the identity.

STRUCT(
"last_checked_timestamp" TIMESTAMP_S,
"last_success_timestamp" TIMESTAMP_S,
"error_type" VARCHAR,
"soa_record" STRUCT(
"primary_name_server" VARCHAR,
"admin_email" VARCHAR,
"serial_number" BIGINT
)
)
Show child fields
verification_info.error_type

Provides the reason for the failure describing why Amazon SES was not able to successfully verify the identity. Below are the possible values:

  • INVALID_VALUE – Amazon SES was able to find the record, but the value contained within the record was invalid. Ensure you have published the correct values for the record.

  • TYPE_NOT_FOUND – The queried hostname exists but does not have the requested type of DNS record. Ensure that you have published the correct type of DNS record.

  • HOST_NOT_FOUND – The queried hostname does not exist or was not reachable at the time of the request. Ensure that you have published the required DNS record(s).

  • SERVICE_ERROR – A temporary issue is preventing Amazon SES from determining the verification status of the domain.

  • DNS_SERVER_ERROR – The DNS server encountered an issue and was unable to complete the request.

verification_info.last_checked_timestamp

The last time a verification attempt was made for this identity.

verification_info.last_success_timestamp

The last time a successful verification was made for this identity.

verification_info.soa_record

An object that contains information about the start of authority (SOA) record associated with the identity.

Show child fields
verification_info.soa_record.admin_email

Administrative contact email from the SOA record.

verification_info.soa_record.primary_name_server

Primary name server specified in the SOA record.

verification_info.soa_record.serial_number

Serial number from the SOA record.

verification_status

The verification status of the identity. The status can be one of the following:

  • PENDING – The verification process was initiated, but Amazon SES hasn't yet been able to verify the identity.

  • SUCCESS – The verification process completed successfully.

  • FAILED – The verification process failed.

  • TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the verification status of the identity.

  • NOT_STARTED – The verification process hasn't been initiated for the identity.

VARCHAR
verified_for_sending_status

Specifies whether or not the identity is verified. You can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.

BOOLEAN