:doc:`ComputeOptimizerAutomation <../../compute-optimizer-automation>` / Client / list_automation_rule_preview_summaries

**************************************
list_automation_rule_preview_summaries
**************************************



.. py:method:: ComputeOptimizerAutomation.Client.list_automation_rule_preview_summaries(**kwargs)

  

  Returns a summary of the recommended actions that match your rule preview configuration and criteria.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-automation-2025-09-22/ListAutomationRulePreviewSummaries>`_  


  **Request Syntax**
  ::

    response = client.list_automation_rule_preview_summaries(
        ruleType='OrganizationRule'|'AccountRule',
        organizationScope={
            'accountIds': [
                'string',
            ]
        },
        recommendedActionTypes=[
            'SnapshotAndDeleteUnattachedEbsVolume'|'UpgradeEbsVolumeType',
        ],
        criteria={
            'region': [
                {
                    'comparison': 'StringEquals'|'StringNotEquals'|'StringEqualsIgnoreCase'|'StringNotEqualsIgnoreCase'|'StringLike'|'StringNotLike'|'NumericEquals'|'NumericNotEquals'|'NumericLessThan'|'NumericLessThanEquals'|'NumericGreaterThan'|'NumericGreaterThanEquals',
                    'values': [
                        'string',
                    ]
                },
            ],
            'resourceArn': [
                {
                    'comparison': 'StringEquals'|'StringNotEquals'|'StringEqualsIgnoreCase'|'StringNotEqualsIgnoreCase'|'StringLike'|'StringNotLike'|'NumericEquals'|'NumericNotEquals'|'NumericLessThan'|'NumericLessThanEquals'|'NumericGreaterThan'|'NumericGreaterThanEquals',
                    'values': [
                        'string',
                    ]
                },
            ],
            'ebsVolumeType': [
                {
                    'comparison': 'StringEquals'|'StringNotEquals'|'StringEqualsIgnoreCase'|'StringNotEqualsIgnoreCase'|'StringLike'|'StringNotLike'|'NumericEquals'|'NumericNotEquals'|'NumericLessThan'|'NumericLessThanEquals'|'NumericGreaterThan'|'NumericGreaterThanEquals',
                    'values': [
                        'string',
                    ]
                },
            ],
            'ebsVolumeSizeInGib': [
                {
                    'comparison': 'StringEquals'|'StringNotEquals'|'StringEqualsIgnoreCase'|'StringNotEqualsIgnoreCase'|'StringLike'|'StringNotLike'|'NumericEquals'|'NumericNotEquals'|'NumericLessThan'|'NumericLessThanEquals'|'NumericGreaterThan'|'NumericGreaterThanEquals',
                    'values': [
                        123,
                    ]
                },
            ],
            'estimatedMonthlySavings': [
                {
                    'comparison': 'StringEquals'|'StringNotEquals'|'StringEqualsIgnoreCase'|'StringNotEqualsIgnoreCase'|'StringLike'|'StringNotLike'|'NumericEquals'|'NumericNotEquals'|'NumericLessThan'|'NumericLessThanEquals'|'NumericGreaterThan'|'NumericGreaterThanEquals',
                    'values': [
                        123.0,
                    ]
                },
            ],
            'resourceTag': [
                {
                    'comparison': 'StringEquals'|'StringNotEquals'|'StringEqualsIgnoreCase'|'StringNotEqualsIgnoreCase'|'StringLike'|'StringNotLike'|'NumericEquals'|'NumericNotEquals'|'NumericLessThan'|'NumericLessThanEquals'|'NumericGreaterThan'|'NumericGreaterThanEquals',
                    'key': 'string',
                    'values': [
                        'string',
                    ]
                },
            ],
            'lookBackPeriodInDays': [
                {
                    'comparison': 'StringEquals'|'StringNotEquals'|'StringEqualsIgnoreCase'|'StringNotEqualsIgnoreCase'|'StringLike'|'StringNotLike'|'NumericEquals'|'NumericNotEquals'|'NumericLessThan'|'NumericLessThanEquals'|'NumericGreaterThan'|'NumericGreaterThanEquals',
                    'values': [
                        123,
                    ]
                },
            ],
            'restartNeeded': [
                {
                    'comparison': 'StringEquals'|'StringNotEquals'|'StringEqualsIgnoreCase'|'StringNotEqualsIgnoreCase'|'StringLike'|'StringNotLike'|'NumericEquals'|'NumericNotEquals'|'NumericLessThan'|'NumericLessThanEquals'|'NumericGreaterThan'|'NumericGreaterThanEquals',
                    'values': [
                        'string',
                    ]
                },
            ]
        },
        maxResults=123,
        nextToken='string'
    )
    
  :type ruleType: string
  :param ruleType: **[REQUIRED]** 

    The type of rule.

    

  
  :type organizationScope: dict
  :param organizationScope: 

    The organizational scope for the rule preview.

    

  
    - **accountIds** *(list) --* 

      List of Amazon Web Services account IDs to include in the organization scope.

      

    
      - *(string) --* 

      
  
  
  :type recommendedActionTypes: list
  :param recommendedActionTypes: **[REQUIRED]** 

    The types of recommended actions to include in the preview.

    

  
    - *(string) --* 

      Recommended action type enumeration

      

    

  :type criteria: dict
  :param criteria: 

    A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time. You can specify up to 20 conditions per filter criteria and 20 values per condition.

    

  
    - **region** *(list) --* 

      Filter criteria for Amazon Web Services regions where resources must be located.

      

    
      - *(dict) --* 

        Criteria condition for filtering based on string values, including comparison operators and target values.

        

      
        - **comparison** *(string) --* 

          The comparison operator used to evaluate the string criteria, such as equals, not equals, or contains.

          

        
        - **values** *(list) --* 

          List of string values to compare against when applying the criteria condition.

          

        
          - *(string) --* 

          
      
      
  
    - **resourceArn** *(list) --* 

      Filter criteria for specific resource ARNs to include or exclude.

      

    
      - *(dict) --* 

        Criteria condition for filtering based on string values, including comparison operators and target values.

        

      
        - **comparison** *(string) --* 

          The comparison operator used to evaluate the string criteria, such as equals, not equals, or contains.

          

        
        - **values** *(list) --* 

          List of string values to compare against when applying the criteria condition.

          

        
          - *(string) --* 

          
      
      
  
    - **ebsVolumeType** *(list) --* 

      Filter criteria for EBS volume types, such as gp2, gp3, io1, io2, st1, or sc1.

      

    
      - *(dict) --* 

        Criteria condition for filtering based on string values, including comparison operators and target values.

        

      
        - **comparison** *(string) --* 

          The comparison operator used to evaluate the string criteria, such as equals, not equals, or contains.

          

        
        - **values** *(list) --* 

          List of string values to compare against when applying the criteria condition.

          

        
          - *(string) --* 

          
      
      
  
    - **ebsVolumeSizeInGib** *(list) --* 

      Filter criteria for EBS volume sizes in gibibytes (GiB).

      

    
      - *(dict) --* 

        Defines a condition for filtering based on integer values with comparison operators.

        

      
        - **comparison** *(string) --* 

          The comparison operator to use, such as equals, greater than, less than, etc.

          

        
        - **values** *(list) --* 

          The list of integer values to compare against using the specified comparison operator.

          

        
          - *(integer) --* 

          
      
      
  
    - **estimatedMonthlySavings** *(list) --* 

      Filter criteria for estimated monthly cost savings from the recommended action.

      

    
      - *(dict) --* 

        Defines a condition for filtering based on double/floating-point numeric values with comparison operators.

        

      
        - **comparison** *(string) --* 

          The comparison operator to use, such as equals, greater than, less than, etc.

          

        
        - **values** *(list) --* 

          The list of double values to compare against using the specified comparison operator.

          

        
          - *(float) --* 

          
      
      
  
    - **resourceTag** *(list) --* 

      Filter criteria for resource tags, allowing filtering by tag key and value combinations.

      

    
      - *(dict) --* 

        Criteria condition for filtering resources based on their tags, including comparison operators and values.

        

      
        - **comparison** *(string) --* 

          The comparison operator used to evaluate the tag criteria, such as equals, not equals, or contains.

          

        
        - **key** *(string) --* 

          The tag key to use for comparison when filtering resources.

          

        
        - **values** *(list) --* 

          List of tag values to compare against when filtering resources.

          

        
          - *(string) --* 

          
      
      
  
    - **lookBackPeriodInDays** *(list) --* 

      Filter criteria for the lookback period in days used to analyze resource utilization.

      

    
      - *(dict) --* 

        Defines a condition for filtering based on integer values with comparison operators.

        

      
        - **comparison** *(string) --* 

          The comparison operator to use, such as equals, greater than, less than, etc.

          

        
        - **values** *(list) --* 

          The list of integer values to compare against using the specified comparison operator.

          

        
          - *(integer) --* 

          
      
      
  
    - **restartNeeded** *(list) --* 

      Filter criteria indicating whether the recommended action requires a resource restart.

      

    
      - *(dict) --* 

        Criteria condition for filtering based on string values, including comparison operators and target values.

        

      
        - **comparison** *(string) --* 

          The comparison operator used to evaluate the string criteria, such as equals, not equals, or contains.

          

        
        - **values** *(list) --* 

          List of string values to compare against when applying the criteria condition.

          

        
          - *(string) --* 

          
      
      
  
  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of automation rule preview summaries to return in a single response. Valid range is 1-1000.

    

  
  :type nextToken: string
  :param nextToken: 

    A token used for pagination to retrieve the next set of results when the response is truncated.

    

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

    
    ::

      {
          'previewResultSummaries': [
              {
                  'key': 'string',
                  'total': {
                      'recommendedActionCount': 123,
                      'estimatedMonthlySavings': {
                          'currency': 'string',
                          'beforeDiscountSavings': 123.0,
                          'afterDiscountSavings': 123.0,
                          'savingsEstimationMode': 'BeforeDiscount'|'AfterDiscount'
                      }
                  }
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **previewResultSummaries** *(list) --* 

        The list of automation rule preview summaries that match the specified criteria.

        
        

        - *(dict) --* 

          Contains a summary of preview results for an automation rule.

          
          

          - **key** *(string) --* 

            The key identifier for this preview result summary.

            
          

          - **total** *(dict) --* 

            Aggregate totals for automation rule preview results, including count and estimated savings.

            
            

            - **recommendedActionCount** *(integer) --* 

              The total number of recommended actions matching the rule preview configuration.

              
            

            - **estimatedMonthlySavings** *(dict) --* 

              Contains information about estimated monthly cost savings.

              
              

              - **currency** *(string) --* 

                The currency of the estimated savings.

                
              

              - **beforeDiscountSavings** *(float) --* 

                The estimated monthly savings before applying any discounts.

                
              

              - **afterDiscountSavings** *(float) --* 

                The estimated monthly savings after applying any discounts.

                
              

              - **savingsEstimationMode** *(string) --* 

                The mode used to calculate savings, either BeforeDiscount or AfterDiscount.

                
          
        
      
    
      

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

        A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.

        
  
  **Exceptions**
  
  *   :py:class:`ComputeOptimizerAutomation.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`ComputeOptimizerAutomation.Client.exceptions.ForbiddenException`

  
  *   :py:class:`ComputeOptimizerAutomation.Client.exceptions.OptInRequiredException`

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

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

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

  
  *   :py:class:`ComputeOptimizerAutomation.Client.exceptions.ServiceUnavailableException`

  