GetBlacklistReportsCommand

Suggest an Edit

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

Example Syntax

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

import { PinpointEmailClient, GetBlacklistReportsCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import
// const { PinpointEmailClient, GetBlacklistReportsCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import
const client = new PinpointEmailClient(config);
const input = { // GetBlacklistReportsRequest
  BlacklistItemNames: [ // BlacklistItemNames // required
    "STRING_VALUE",
  ],
};
const command = new GetBlacklistReportsCommand(input);
const response = await client.send(command);
// { // GetBlacklistReportsResponse
//   BlacklistReport: { // BlacklistReport // required
//     "<keys>": [ // BlacklistEntries
//       { // BlacklistEntry
//         RblName: "STRING_VALUE",
//         ListingTime: new Date("TIMESTAMP"),
//         Description: "STRING_VALUE",
//       },
//     ],
//   },
// };

GetBlacklistReportsCommand Input

See GetBlacklistReportsCommandInput for more details

Parameter
Type
Description
BlacklistItemNames
Required
string[] | undefined

A list of IP addresses that you want to retrieve blacklist information about. You can only specify the dedicated IP addresses that you use to send email using Amazon Pinpoint or Amazon SES.

GetBlacklistReportsCommand Output

See GetBlacklistReportsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
BlacklistReport
Required
Record<string, BlacklistEntry[]> | undefined

An object that contains information about a blacklist that one of your dedicated IP addresses appears on.

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.

PinpointEmailServiceException
Base exception class for all service exceptions from PinpointEmail service.