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

GetMessageInsights

Provides information about a specific message, including the from address, the subject, the recipient address, email tags, as well as events associated with the message.

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

Request Syntax


GET /v2/email/insights/MessageId/ HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MessageId

A MessageId is a unique identifier for a message, and is returned when sending emails through Amazon SES.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "EmailTags": [ 
      { 
         "Name": "string",
         "Value": "string"
      }
   ],
   "FromEmailAddress": "string",
   "Insights": [ 
      { 
         "Destination": "string",
         "Events": [ 
            { 
               "Details": { 
                  "Bounce": { 
                     "BounceSubType": "string",
                     "BounceType": "string",
                     "DiagnosticCode": "string"
                  },
                  "Complaint": { 
                     "ComplaintFeedbackType": "string",
                     "ComplaintSubType": "string"
                  }
               },
               "Timestamp": number,
               "Type": "string"
            }
         ],
         "Isp": "string"
      }
   ],
   "MessageId": "string",
   "Subject": "string"
}

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.

EmailTags

A list of tags, in the form of name/value pairs, that were applied to the email you sent, along with Amazon SES Auto-Tags.

Type: Array of MessageTag objects

FromEmailAddress

The from address used to send the message.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 320.

Insights

A set of insights associated with the message.

Type: Array of EmailInsights objects

MessageId

A unique identifier for the message.

Type: String

Subject

The subject line of the message.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 998.

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