Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetEmailIdentity

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.

Request Syntax


GET /v2/email/identities/EmailIdentity HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

EmailIdentity

The email identity.

Length Constraints: Minimum length of 1.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ConfigurationSetName": "string",
   "DkimAttributes": { 
      "CurrentSigningKeyLength": "string",
      "LastKeyGenerationTimestamp": number,
      "NextSigningKeyLength": "string",
      "SigningAttributesOrigin": "string",
      "SigningEnabled": boolean,
      "Status": "string",
      "Tokens": [ "string" ]
   },
   "FeedbackForwardingStatus": boolean,
   "IdentityType": "string",
   "MailFromAttributes": { 
      "BehaviorOnMxFailure": "string",
      "MailFromDomain": "string",
      "MailFromDomainStatus": "string"
   },
   "Policies": { 
      "string" : "string" 
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VerificationInfo": { 
      "ErrorType": "string",
      "LastCheckedTimestamp": number,
      "LastSuccessTimestamp": number,
      "SOARecord": { 
         "AdminEmail": "string",
         "PrimaryNameServer": "string",
         "SerialNumber": number
      }
   },
   "VerificationStatus": "string",
   "VerifiedForSendingStatus": boolean
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ConfigurationSetName

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

Type: String

DkimAttributes

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

Type: DkimAttributes object

FeedbackForwardingStatus

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).

Type: Boolean

IdentityType

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

Type: String

Valid Values: EMAIL_ADDRESS | DOMAIN | MANAGED_DOMAIN

MailFromAttributes

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

Type: MailFromAttributes object

Policies

A map of policy names to policies.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Value Length Constraints: Minimum length of 1.

Tags

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

Type: Array of Tag objects

VerificationInfo

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

Type: VerificationInfo object

VerificationStatus

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.

Type: String

Valid Values: PENDING | SUCCESS | FAILED | TEMPORARY_FAILURE | NOT_STARTED

VerifiedForSendingStatus

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.

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429