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

*******************
DescribeOptOutLists
*******************



.. py:class:: PinpointSMSVoiceV2.Paginator.DescribeOptOutLists

  ::

    
    paginator = client.get_paginator('describe_opt_out_lists')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          OptOutListNames=[
              'string',
          ],
          Owner='SELF'|'SHARED',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type OptOutListNames: list
    :param OptOutListNames: 

      The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

       

      .. warning::

         

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

        

      

    
      - *(string) --* 

      
  
    :type Owner: string
    :param Owner: 

      Use ``SELF`` to filter the list of Opt-Out List to ones your account owns or use ``SHARED`` to filter on Opt-Out List shared with your account. The ``Owner`` and ``OptOutListNames`` parameters can't be used at the same time.

      

    
    :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**

      
      ::

        {
            'OptOutLists': [
                {
                    'OptOutListArn': 'string',
                    'OptOutListName': 'string',
                    'CreatedTimestamp': datetime(2015, 1, 1)
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **OptOutLists** *(list) --* 

          An array of OptOutListInformation objects that contain the details for the requested OptOutLists.

          
          

          - *(dict) --* 

            The information for all OptOutList in an Amazon Web Services account.

            
            

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

              The Amazon Resource Name (ARN) of the OptOutList.

              
            

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

              The name of the OptOutList.

              
            

            - **CreatedTimestamp** *(datetime) --* 

              The time when the OutOutList was created, in `UNIX epoch time <https://www.epochconverter.com/>`__ format.

              
        
      
    