:doc:`PinpointSMSVoiceV2 <../../pinpoint-sms-voice-v2>` / Paginator / DescribeOptedOutNumbers

***********************
DescribeOptedOutNumbers
***********************



.. py:class:: PinpointSMSVoiceV2.Paginator.DescribeOptedOutNumbers

  ::

    
    paginator = client.get_paginator('describe_opted_out_numbers')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`PinpointSMSVoiceV2.Client.describe_opted_out_numbers`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeOptedOutNumbers>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          OptOutListName='string',
          OptedOutNumbers=[
              'string',
          ],
          Filters=[
              {
                  'Name': 'end-user-opted-out',
                  'Values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type OptOutListName: string
    :param OptOutListName: **[REQUIRED]** 

      The OptOutListName or OptOutListArn of the OptOutList. You can use  DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

       

      .. warning::

         

        If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).

        

      

    
    :type OptedOutNumbers: list
    :param OptedOutNumbers: 

      An array of phone numbers to search for in the OptOutList.

       

      If you specify an opted out number that isn't valid, an exception is returned.

      

    
      - *(string) --* 

      
  
    :type Filters: list
    :param Filters: 

      An array of OptedOutFilter objects to filter the results on.

      

    
      - *(dict) --* 

        The information for opted out numbers that meet a specified criteria.

        

      
        - **Name** *(string) --* **[REQUIRED]** 

          The name of the attribute to filter on.

          

        
        - **Values** *(list) --* **[REQUIRED]** 

          An array of values to filter for.

          

        
          - *(string) --* 

          
      
      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'OptOutListArn': 'string',
            'OptOutListName': 'string',
            'OptedOutNumbers': [
                {
                    'OptedOutNumber': 'string',
                    'OptedOutTimestamp': datetime(2015, 1, 1),
                    'EndUserOptedOut': True|False
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **OptOutListArn** *(string) --* 

          The Amazon Resource Name (ARN) of the OptOutList.

          
        

        - **OptOutListName** *(string) --* 

          The name of the OptOutList.

          
        

        - **OptedOutNumbers** *(list) --* 

          An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

          
          

          - *(dict) --* 

            The information for an opted out number in an Amazon Web Services account.

            
            

            - **OptedOutNumber** *(string) --* 

              The phone number that is opted out.

              
            

            - **OptedOutTimestamp** *(datetime) --* 

              The time that the op tout occurred, in `UNIX epoch time <https://www.epochconverter.com/>`__ format.

              
            

            - **EndUserOptedOut** *(boolean) --* 

              This is set to true if it was the end recipient that opted out.

              
        
      
    