SESV2 / Client / list_recommendations

list_recommendations#

SESV2.Client.list_recommendations(**kwargs)#

Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region.

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

See also: AWS API Documentation

Request Syntax

response = client.list_recommendations(
    Filter={
        'string': 'string'
    },
    NextToken='string',
    PageSize=123
)
Parameters:

  • Filter (dict) –

    Filters applied when retrieving recommendations. Can eiter be an individual filter, or combinations of STATUS and IMPACT or STATUS and TYPE

    • (string) –

      The ListRecommendations filter type. This can be one of the following:

      • TYPE – The recommendation type, with values like DKIM, SPF, DMARC or BIMI.

      • IMPACT – The recommendation impact, with values like HIGH or LOW.

      • STATUS – The recommendation status, with values like OPEN or FIXED.

      • RESOURCE_ARN – The resource affected by the recommendation, with values like arn:aws:ses:us-east-1:123456789012:identity/example.com.

      • (string) –

  • NextToken (string) – A token returned from a previous call to ListRecommendations to indicate the position in the list of recommendations.

  • PageSize (integer) –

    The number of results to show in a single call to ListRecommendations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

    The value you specify has to be at least 1, and can be no more than 100.

Return type:

dict

Returns:

Response Syntax

{
    'Recommendations': [
        {
            'ResourceArn': 'string',
            'Type': 'DKIM'|'DMARC'|'SPF'|'BIMI',
            'Description': 'string',
            'Status': 'OPEN'|'FIXED',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'LastUpdatedTimestamp': datetime(2015, 1, 1),
            'Impact': 'LOW'|'HIGH'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Contains the response to your request to retrieve the list of recommendations for your account.

    • Recommendations (list) –

      The recommendations applicable to your account.

      • (dict) –

        A recommendation generated for your account.

        • ResourceArn (string) –

          The resource affected by the recommendation, with values like arn:aws:ses:us-east-1:123456789012:identity/example.com.

        • Type (string) –

          The recommendation type, with values like DKIM, SPF, DMARC or BIMI.

        • Description (string) –

          The recommendation description / disambiguator - e.g. DKIM1 and DKIM2 are different recommendations about your DKIM setup.

        • Status (string) –

          The recommendation status, with values like OPEN or FIXED.

        • CreatedTimestamp (datetime) –

          The first time this issue was encountered and the recommendation was generated.

        • LastUpdatedTimestamp (datetime) –

          The last time the recommendation was updated.

        • Impact (string) –

          The recommendation impact, with values like HIGH or LOW.

    • NextToken (string) –

      A string token indicating that there might be additional recommendations available to be listed. Use the token provided in the ListRecommendationsResponse to use in the subsequent call to ListRecommendations with the same parameters to retrieve the next page of recommendations.

Exceptions

  • SESV2.Client.exceptions.TooManyRequestsException

  • SESV2.Client.exceptions.BadRequestException

  • SESV2.Client.exceptions.NotFoundException