:doc:`PartnerCentralBenefits <../../partnercentral-benefits>` / Paginator / ListBenefits

************
ListBenefits
************



.. py:class:: PartnerCentralBenefits.Paginator.ListBenefits

  ::

    
    paginator = client.get_paginator('list_benefits')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`PartnerCentralBenefits.Client.list_benefits`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/partnercentral-benefits-2018-05-10/ListBenefits>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Catalog='string',
          Programs=[
              'string',
          ],
          FulfillmentTypes=[
              'CREDITS'|'CASH'|'ACCESS',
          ],
          Status=[
              'ACTIVE'|'INACTIVE',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Catalog: string
    :param Catalog: **[REQUIRED]** 

      The catalog identifier to filter benefits by catalog.

      

    
    :type Programs: list
    :param Programs: 

      Filter benefits by specific AWS partner programs.

      

    
      - *(string) --* 

      
  
    :type FulfillmentTypes: list
    :param FulfillmentTypes: 

      Filter benefits by specific fulfillment types.

      

    
      - *(string) --* 

      
  
    :type Status: list
    :param Status: 

      Filter benefits by their current status.

      

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

      
      ::

        {
            'BenefitSummaries': [
                {
                    'Id': 'string',
                    'Catalog': 'string',
                    'Arn': 'string',
                    'Name': 'string',
                    'Description': 'string',
                    'Programs': [
                        'string',
                    ],
                    'FulfillmentTypes': [
                        'CREDITS'|'CASH'|'ACCESS',
                    ],
                    'Status': 'ACTIVE'|'INACTIVE'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **BenefitSummaries** *(list) --* 

          A list of benefit summaries matching the specified criteria.

          
          

          - *(dict) --* 

            A summary view of a benefit containing key information for list operations.

            
            

            - **Id** *(string) --* 

              The unique identifier of the benefit.

              
            

            - **Catalog** *(string) --* 

              The catalog identifier that the benefit belongs to.

              
            

            - **Arn** *(string) --* 

              The Amazon Resource Name (ARN) of the benefit.

              
            

            - **Name** *(string) --* 

              The human-readable name of the benefit.

              
            

            - **Description** *(string) --* 

              A brief description of the benefit and its purpose.

              
            

            - **Programs** *(list) --* 

              The AWS partner programs that this benefit is associated with.

              
              

              - *(string) --* 
          
            

            - **FulfillmentTypes** *(list) --* 

              The available fulfillment types for this benefit.

              
              

              - *(string) --* 
          
            

            - **Status** *(string) --* 

              The current status of the benefit.

              
        
      
    