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

*************************
list_benefit_applications
*************************



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

  

  Retrieves a paginated list of benefit applications based on specified filter criteria.

  

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


  **Request Syntax**
  ::

    response = client.list_benefit_applications(
        Catalog='string',
        Programs=[
            'string',
        ],
        FulfillmentTypes=[
            'CREDITS'|'CASH'|'ACCESS',
        ],
        BenefitIdentifiers=[
            'string',
        ],
        Status=[
            'PENDING_SUBMISSION'|'IN_REVIEW'|'ACTION_REQUIRED'|'APPROVED'|'REJECTED'|'CANCELED',
        ],
        Stages=[
            'string',
        ],
        AssociatedResources=[
            {
                'ResourceType': 'OPPORTUNITY'|'BENEFIT_ALLOCATION',
                'ResourceIdentifier': 'string',
                'ResourceArn': 'string'
            },
        ],
        AssociatedResourceArns=[
            'string',
        ],
        MaxResults=123,
        NextToken='string'
    )
    
  :type Catalog: string
  :param Catalog: **[REQUIRED]** 

    The catalog identifier to filter benefit applications by catalog.

    

  
  :type Programs: list
  :param Programs: 

    Filter benefit applications by specific AWS partner programs.

    

  
    - *(string) --* 

    

  :type FulfillmentTypes: list
  :param FulfillmentTypes: 

    Filter benefit applications by specific fulfillment types.

    

  
    - *(string) --* 

    

  :type BenefitIdentifiers: list
  :param BenefitIdentifiers: 

    Filter benefit applications by specific benefit identifiers.

    

  
    - *(string) --* 

    

  :type Status: list
  :param Status: 

    Filter benefit applications by their current processing status.

    

  
    - *(string) --* 

    

  :type Stages: list
  :param Stages: 

    Filter benefit applications by their current processing stage.

    

  
    - *(string) --* 

    

  :type AssociatedResources: list
  :param AssociatedResources: 

    Filter benefit applications by associated AWS resources.

    

  
    - *(dict) --* 

      Represents an AWS resource that is associated with a benefit application for tracking and management.

      

    
      - **ResourceType** *(string) --* 

        The type of AWS resource (e.g., EC2 instance, S3 bucket, Lambda function).

        

      
      - **ResourceIdentifier** *(string) --* 

        The unique identifier of the AWS resource within its service.

        

      
      - **ResourceArn** *(string) --* 

        The Amazon Resource Name (ARN) that uniquely identifies the AWS resource.

        

      
    

  :type AssociatedResourceArns: list
  :param AssociatedResourceArns: 

    Filter benefit applications by specific AWS resource ARNs.

    

  
    - *(string) --* 

    

  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of benefit applications 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**

    
    ::

      {
          'BenefitApplicationSummaries': [
              {
                  'Catalog': 'string',
                  'Name': 'string',
                  'Id': 'string',
                  'Arn': 'string',
                  'BenefitId': 'string',
                  'Programs': [
                      'string',
                  ],
                  'FulfillmentTypes': [
                      'CREDITS'|'CASH'|'ACCESS',
                  ],
                  'Status': 'PENDING_SUBMISSION'|'IN_REVIEW'|'ACTION_REQUIRED'|'APPROVED'|'REJECTED'|'CANCELED',
                  'Stage': 'string',
                  'CreatedAt': datetime(2015, 1, 1),
                  'UpdatedAt': datetime(2015, 1, 1),
                  'BenefitApplicationDetails': {
                      'string': 'string'
                  },
                  'AssociatedResources': [
                      'string',
                  ]
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **BenefitApplicationSummaries** *(list) --* 

        A list of benefit application summaries matching the specified criteria.

        
        

        - *(dict) --* 

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

          
          

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

            The catalog identifier that the benefit application belongs to.

            
          

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

            The human-readable name of the benefit application.

            
          

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

            The unique identifier of the benefit application.

            
          

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

            The Amazon Resource Name (ARN) of the benefit application.

            
          

          - **BenefitId** *(string) --* 

            The identifier of the benefit being requested in this application.

            
          

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

            The AWS partner programs associated with this benefit application.

            
            

            - *(string) --* 
        
          

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

            The fulfillment types requested for this benefit application.

            
            

            - *(string) --* 
        
          

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

            The current processing status of the benefit application.

            
          

          - **Stage** *(string) --* 

            The current stage in the benefit application processing workflow..

            
          

          - **CreatedAt** *(datetime) --* 

            The timestamp when the benefit application was created.

            
          

          - **UpdatedAt** *(datetime) --* 

            The timestamp when the benefit application was last updated.

            
          

          - **BenefitApplicationDetails** *(dict) --* 

            Additional attributes and metadata associated with the benefit application.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
          

          - **AssociatedResources** *(list) --* 

            AWS resources that are associated with this benefit application.

            
            

            - *(string) --* 
        
      
    
      

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

  