:doc:`SESV2 <../../sesv2>` / Client / list_suppressed_destinations

****************************
list_suppressed_destinations
****************************



.. py:method:: SESV2.Client.list_suppressed_destinations(**kwargs)

  

  Retrieves a list of email addresses that are on the suppression list for your account.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListSuppressedDestinations>`_  


  **Request Syntax**
  ::

    response = client.list_suppressed_destinations(
        Reasons=[
            'BOUNCE'|'COMPLAINT',
        ],
        StartDate=datetime(2015, 1, 1),
        EndDate=datetime(2015, 1, 1),
        NextToken='string',
        PageSize=123
    )
    
  :type Reasons: list
  :param Reasons: 

    The factors that caused the email address to be added to .

    

  
    - *(string) --* 

      The reason that the address was added to the suppression list for your account. The value can be one of the following:

       

      
      * ``COMPLAINT`` – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a complaint.
       
      * ``BOUNCE`` – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a hard bounce.
      

      

    

  :type StartDate: datetime
  :param StartDate: 

    Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date.

    

  
  :type EndDate: datetime
  :param EndDate: 

    Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date.

    

  
  :type NextToken: string
  :param NextToken: 

    A token returned from a previous call to ``ListSuppressedDestinations`` to indicate the position in the list of suppressed email addresses.

    

  
  :type PageSize: integer
  :param PageSize: 

    The number of results to show in a single call to ``ListSuppressedDestinations``. 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.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'SuppressedDestinationSummaries': [
              {
                  'EmailAddress': 'string',
                  'Reason': 'BOUNCE'|'COMPLAINT',
                  'LastUpdateTime': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      A list of suppressed email addresses.

      
      

      - **SuppressedDestinationSummaries** *(list) --* 

        A list of summaries, each containing a summary for a suppressed email destination.

        
        

        - *(dict) --* 

          A summary that describes the suppressed email address.

          
          

          - **EmailAddress** *(string) --* 

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

            
          

          - **Reason** *(string) --* 

            The reason that the address was added to the suppression list for your account.

            
          

          - **LastUpdateTime** *(datetime) --* 

            The date and time when the suppressed destination was last updated, shown in Unix time format.

            
      
    
      

      - **NextToken** *(string) --* 

        A token that indicates that there are additional email addresses on the suppression list for your account. To view additional suppressed addresses, issue another request to ``ListSuppressedDestinations``, and pass this token in the ``NextToken`` parameter.

        
  
  **Exceptions**
  
  *   :py:class:`SESV2.Client.exceptions.BadRequestException`

  
  *   :py:class:`SESV2.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`SESV2.Client.exceptions.InvalidNextTokenException`

  