:doc:`PartnerCentralBenefits <../../partnercentral-benefits>` / Client / list_benefits

*************
list_benefits
*************



.. py:method:: PartnerCentralBenefits.Client.list_benefits(**kwargs)

  

  Retrieves a paginated list of available benefits based on specified filter criteria.

  

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


  **Request Syntax**
  ::

    response = client.list_benefits(
        Catalog='string',
        Programs=[
            'string',
        ],
        FulfillmentTypes=[
            'CREDITS'|'CASH'|'ACCESS',
        ],
        Status=[
            'ACTIVE'|'INACTIVE',
        ],
        MaxResults=123,
        NextToken='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 MaxResults: integer
  :param MaxResults: 

    The maximum number of benefits to return in a single response.

    

  
  :type NextToken: string
  :param NextToken: 

    A pagination token to retrieve the next set of results from a previous request.

    

  
  
  :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'
              },
          ],
          'NextToken': 'string'
      }
      
    **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.

            
      
    
      

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

        A pagination token to retrieve the next set of results, if more results are available.

        
  
  **Exceptions**
  
  *   :py:class:`PartnerCentralBenefits.Client.exceptions.ValidationException`

  
  *   :py:class:`PartnerCentralBenefits.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`PartnerCentralBenefits.Client.exceptions.InternalServerException`

  
  *   :py:class:`PartnerCentralBenefits.Client.exceptions.ThrottlingException`

  
  *   :py:class:`PartnerCentralBenefits.Client.exceptions.ResourceNotFoundException`

  