PinpointEmail / Client / get_blacklist_reports

get_blacklist_reports#

PinpointEmail.Client.get_blacklist_reports(**kwargs)#

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

Request Syntax

response = client.get_blacklist_reports(
    BlacklistItemNames=[
        'string',
    ]
)

Parameters:

BlacklistItemNames (list) –

[REQUIRED]

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.

(string) –

An IP address that you want to obtain blacklist information for.

Return type:

dict

Returns:

Response Syntax

{
    'BlacklistReport': {
        'string': [
            {
                'RblName': 'string',
                'ListingTime': datetime(2015, 1, 1),
                'Description': 'string'
            },
        ]
    }
}

Response Structure

(dict) –

An object that contains information about blacklist events.
- BlacklistReport (dict) –
  
  An object that contains information about a blacklist that one of your dedicated IP addresses appears on.
  - (string) –
    
    An IP address that you want to obtain blacklist information for.
    - (list) –
      - (dict) –
        
        An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.
        
        RblName (string) –
        
        The name of the blacklist that the IP address appears on.
        
        ListingTime (datetime) –
        
        The time when the blacklisting event occurred, shown in Unix time format.
        
        Description (string) –
        
        Additional information about the blacklisting event, as provided by the blacklist maintainer.

Exceptions

PinpointEmail.Client.exceptions.TooManyRequestsException
PinpointEmail.Client.exceptions.NotFoundException
PinpointEmail.Client.exceptions.BadRequestException