:doc:`ConnectCampaignService <../../connectcampaigns>` / Paginator / ListCampaigns

*************
ListCampaigns
*************



.. py:class:: ConnectCampaignService.Paginator.ListCampaigns

  ::

    
    paginator = client.get_paginator('list_campaigns')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`ConnectCampaignService.Client.list_campaigns`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/ListCampaigns>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          filters={
              'instanceIdFilter': {
                  'value': 'string',
                  'operator': 'Eq'
              }
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type filters: dict
    :param filters: 

      Filter model by type

      

    
      - **instanceIdFilter** *(dict) --* 

        Connect instance identifier filter

        

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

          Amazon Connect Instance Id

          

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

          Operators for Connect instance identifier filter

          

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

      
      ::

        {
            'campaignSummaryList': [
                {
                    'id': 'string',
                    'arn': 'string',
                    'name': 'string',
                    'connectInstanceId': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        ListCampaignsResponse

        
        

        - **campaignSummaryList** *(list) --* 

          A list of Amazon Connect campaigns.

          
          

          - *(dict) --* 

            An Amazon Connect campaign summary.

            
            

            - **id** *(string) --* 

              Identifier representing a Campaign

              
            

            - **arn** *(string) --* 

              The resource name of an Amazon Connect campaign.

              
            

            - **name** *(string) --* 

              The name of an Amazon Connect Campaign name.

              
            

            - **connectInstanceId** *(string) --* 

              Amazon Connect Instance Id

              
        
      
        

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

          A token to resume pagination.

          
    