:doc:`BillingandCostManagementRecommendedActions <../../bcm-recommended-actions>` / Client / list_recommended_actions

************************
list_recommended_actions
************************



.. py:method:: BillingandCostManagementRecommendedActions.Client.list_recommended_actions(**kwargs)

  

  Returns a list of recommended actions that match the filter criteria.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bcm-recommended-actions-2024-11-14/ListRecommendedActions>`_  


  **Request Syntax**
  ::

    response = client.list_recommended_actions(
        filter={
            'actions': [
                {
                    'key': 'FEATURE'|'SEVERITY'|'TYPE',
                    'matchOption': 'EQUALS'|'NOT_EQUALS',
                    'values': [
                        'string',
                    ]
                },
            ]
        },
        maxResults=123,
        nextToken='string'
    )
    
  :type filter: dict
  :param filter: 

    The criteria that you want all returned recommended actions to match.

    

  
    - **actions** *(list) --* 

      A list of action filters that define criteria for filtering results. Each filter specifies a key, match option, and corresponding values to filter on.

      

    
      - *(dict) --* 

        Describes a filter that returns a more specific list of recommended actions.

        

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

          The category to filter on. Valid values are ``FEATURE`` for feature type, ``SEVERITY`` for severity level, and ``TYPE`` for recommendation type.

          

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

          Specifies how to apply the filter. Use ``EQUALS`` to include matching results or ``NOT_EQUALS`` to exclude matching results.

          

        
        - **values** *(list) --* **[REQUIRED]** 

          One or more values to match against the specified key.

          

        
          - *(string) --* 

          
      
      
  
  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return in the response.

    

  
  :type nextToken: string
  :param nextToken: 

    The pagination token that indicates the next set of results that you want to retrieve.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'recommendedActions': [
              {
                  'id': 'string',
                  'type': 'ADD_ALTERNATE_BILLING_CONTACT'|'CREATE_ANOMALY_MONITOR'|'CREATE_BUDGET'|'ENABLE_COST_OPTIMIZATION_HUB'|'MIGRATE_TO_GRANULAR_PERMISSIONS'|'PAYMENTS_DUE'|'PAYMENTS_PAST_DUE'|'REVIEW_ANOMALIES'|'REVIEW_BUDGET_ALERTS'|'REVIEW_BUDGETS_EXCEEDED'|'REVIEW_EXPIRING_RI'|'REVIEW_EXPIRING_SP'|'REVIEW_FREETIER_USAGE_ALERTS'|'REVIEW_FREETIER_CREDITS_REMAINING'|'REVIEW_FREETIER_DAYS_REMAINING'|'REVIEW_SAVINGS_OPPORTUNITY_RECOMMENDATIONS'|'UPDATE_EXPIRED_PAYMENT_METHOD'|'UPDATE_INVALID_PAYMENT_METHOD'|'UPDATE_TAX_EXEMPTION_CERTIFICATE'|'UPDATE_TAX_REGISTRATION_NUMBER',
                  'accountId': 'string',
                  'severity': 'INFO'|'WARNING'|'CRITICAL',
                  'feature': 'ACCOUNT'|'BUDGETS'|'COST_ANOMALY_DETECTION'|'COST_OPTIMIZATION_HUB'|'FREE_TIER'|'IAM'|'PAYMENTS'|'RESERVATIONS'|'SAVINGS_PLANS'|'TAX_SETTINGS',
                  'context': {
                      'string': 'string'
                  },
                  'nextSteps': [
                      'string',
                  ],
                  'lastUpdatedTimeStamp': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **recommendedActions** *(list) --* 

        The list of recommended actions that satisfy the filter criteria.

        
        

        - *(dict) --* 

          Describes a specific recommended action.

          
          

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

            The ID for the recommended action.

            
          

          - **type** *(string) --* 

            The type of action you can take by adopting the recommended action.

            
          

          - **accountId** *(string) --* 

            The account that the recommended action is for.

            
          

          - **severity** *(string) --* 

            The severity associated with the recommended action.

            
          

          - **feature** *(string) --* 

            The feature associated with the recommended action.

            
          

          - **context** *(dict) --* 

            Context that applies to the recommended action.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
          

          - **nextSteps** *(list) --* 

            The possible next steps to execute the recommended action.

            
            

            - *(string) --* 
        
          

          - **lastUpdatedTimeStamp** *(string) --* 

            The time when the recommended action status was last updated.

            
      
    
      

      - **nextToken** *(string) --* 

        The pagination token that indicates the next set of results that you want to retrieve.

        
  
  **Exceptions**
  
  *   :py:class:`BillingandCostManagementRecommendedActions.Client.exceptions.AccessDeniedException`

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

  
  *   :py:class:`BillingandCostManagementRecommendedActions.Client.exceptions.ValidationException`

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

  