Skip to main content

ISESV2GetEmailIdentityResponse

Interface in AWS.SESV2

Interface for GetEmailIdentity responses.

Ancestors​

Properties​

ConfigurationSetName​

property ConfigurationSetName: string

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

This property contains the name of the configuration set that will be automatically applied to emails sent from this identity if no configuration set is explicitly specified. If no default configuration set has been assigned to the identity, this property will be empty. Configuration sets allow you to apply consistent settings for tracking, reputation management, and delivery options across your email sending.

DkimAttributes​

property DkimAttributes: ISESV2DkimAttributes

Type: ISESV2DkimAttributes

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

This object provides comprehensive DKIM (DomainKeys Identified Mail) authentication settings for the identity, including signing status, key lengths, tokens, and configuration origin. DKIM authentication helps improve email deliverability by allowing receiving email providers to verify that emails were actually sent from your domain and have not been tampered with in transit.

FeedbackForwardingStatus​

property FeedbackForwardingStatus: Boolean

The feedback forwarding configuration for the identity.

When this value is true, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address specified in the Return-Path header of the original email. You are required to have a method of tracking bounces and complaints. If you have not set up another mechanism for receiving bounce or complaint notifications (such as event destinations), you will receive email notifications even if this setting is disabled.

IdentityType​

property IdentityType: string

The email identity type.

This property indicates whether the identity represents an email address or a domain. The MANAGED_DOMAIN identity type is not supported. Valid values are:

  • EMAIL_ADDRESS – The identity is a specific email address.
  • DOMAIN – The identity is a domain name.

MailFromAttributes​

property MailFromAttributes: ISESV2MailFromAttributes

Type: ISESV2MailFromAttributes

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

This object specifies the custom Mail-From domain configuration, including the domain name, verification status, and behavior when MX record lookup fails. Using a custom Mail-From domain allows you to control the domain that appears in the "From" header of your emails, which can improve deliverability and brand consistency.

Policies​

property Policies: TDictionary<string, string>

A map of policy names to policies.

This property contains sending authorization policies that have been applied to the identity. Each policy defines permissions for other AWS accounts or IAM users to send emails using this identity. Policy names have a minimum length of 1 character and maximum length of 64 characters. The policies themselves must be at least 1 character in length.

Tags​

property Tags: IAWSTags

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

Tags provide a way to organize and categorize your Amazon SES identities for management, billing, and access control purposes. Each tag consists of a key-value pair that you define. You can use tags to track costs, control access through IAM policies, or simply organize your resources.

VerificationInfo​

property VerificationInfo: ISESV2VerificationInfo

Type: ISESV2VerificationInfo

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

This object provides detailed information about the verification process, including error details if verification failed, timestamps for verification attempts, and DNS record information. The verification information helps diagnose issues with identity verification and provides insight into the verification process timeline and any errors encountered.

VerificationStatus​

property VerificationStatus: string

The verification status of the identity.

This property indicates the current state of the identity verification process. Valid values are:

  • PENDING – The verification process was initiated, but Amazon SES has not yet verified 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.
  • NOT_STARTED – The verification process has not been initiated for the identity.

VerifiedForSendingStatus​

property VerifiedForSendingStatus: Boolean

Specifies whether or not the identity is verified.

This boolean value indicates whether the identity can be used to send emails. You can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide. An identity must be successfully verified before it can be used as a sender address.