GetSuppressedDestinationCommand

Suggest an Edit

Retrieves information about a specific email address that's on the suppression list for your account.

Example Syntax

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

import { SESv2Client, GetSuppressedDestinationCommand } from "@aws-sdk/client-sesv2"; // ES Modules import
// const { SESv2Client, GetSuppressedDestinationCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import
const client = new SESv2Client(config);
const input = { // GetSuppressedDestinationRequest
  EmailAddress: "STRING_VALUE", // required
};
const command = new GetSuppressedDestinationCommand(input);
const response = await client.send(command);
// { // GetSuppressedDestinationResponse
//   SuppressedDestination: { // SuppressedDestination
//     EmailAddress: "STRING_VALUE", // required
//     Reason: "BOUNCE" || "COMPLAINT", // required
//     LastUpdateTime: new Date("TIMESTAMP"), // required
//     Attributes: { // SuppressedDestinationAttributes
//       MessageId: "STRING_VALUE",
//       FeedbackId: "STRING_VALUE",
//     },
//   },
// };

GetSuppressedDestinationCommand Input

See GetSuppressedDestinationCommandInput for more details

Parameter
Type
Description
EmailAddress
Required
string | undefined

The email address that's on the account suppression list.

GetSuppressedDestinationCommand Output

See GetSuppressedDestinationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
SuppressedDestination
Required
SuppressedDestination | undefined

An object containing information about the suppressed email address.

Throws

Name
Fault
Details
BadRequestException
client

The input you provided is invalid.

NotFoundException
client

The resource you attempted to access doesn't exist.

TooManyRequestsException
client

Too many requests have been made to the operation.

SESv2ServiceException
Base exception class for all service exceptions from SESv2 service.