Class GetEmailIdentityCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { PinpointEmailClient, GetEmailIdentityCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import
// const { PinpointEmailClient, GetEmailIdentityCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import
const client = new PinpointEmailClient(config);
const input = { // GetEmailIdentityRequest
  EmailIdentity: "STRING_VALUE", // required
};
const command = new GetEmailIdentityCommand(input);
const response = await client.send(command);
// { // GetEmailIdentityResponse
//   IdentityType: "STRING_VALUE",
//   FeedbackForwardingStatus: true || false,
//   VerifiedForSendingStatus: true || false,
//   DkimAttributes: { // DkimAttributes
//     SigningEnabled: true || false,
//     Status: "STRING_VALUE",
//     Tokens: [ // DnsTokenList
//       "STRING_VALUE",
//     ],
//   },
//   MailFromAttributes: { // MailFromAttributes
//     MailFromDomain: "STRING_VALUE", // required
//     MailFromDomainStatus: "STRING_VALUE", // required
//     BehaviorOnMxFailure: "STRING_VALUE", // required
//   },
//   Tags: [ // TagList
//     { // Tag
//       Key: "STRING_VALUE", // required
//       Value: "STRING_VALUE", // required
//     },
//   ],
// };

Param

GetEmailIdentityCommandInput

Returns

GetEmailIdentityCommandOutput

See

• GetEmailIdentityCommandInput for command's input shape.
• GetEmailIdentityCommandOutput for command's response shape.
• config for PinpointEmailClient's config shape.

Throws

BadRequestException (client fault)

The input you provided is invalid.

Throws

NotFoundException (client fault)

The resource you attempted to access doesn't exist.

Throws

TooManyRequestsException (client fault)

Too many requests have been made to the operation.

Throws

PinpointEmailServiceException

Base exception class for all service exceptions from PinpointEmail service.