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

GetEmailIdentity

Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.

Request Syntax


GET /v1/email/identities/EmailIdentity HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

EmailIdentity

The email identity that you want to retrieve details for.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DkimAttributes": { 
      "SigningEnabled": boolean,
      "Status": "string",
      "Tokens": [ "string" ]
   },
   "FeedbackForwardingStatus": boolean,
   "IdentityType": "string",
   "MailFromAttributes": { 
      "BehaviorOnMxFailure": "string",
      "MailFromDomain": "string",
      "MailFromDomainStatus": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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.

DkimAttributes

An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.

Type: DkimAttributes object

FeedbackForwardingStatus

The feedback forwarding configuration for the identity.

If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. 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, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

Type: Boolean

IdentityType

The email identity type.

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

Tags

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

Type: Array of Tag objects

VerifiedForSendingStatus

Specifies whether or not the identity is verified. In Amazon Pinpoint, 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