:doc:`DevOpsGuru <../../devops-guru>` / Client / list_recommendations

********************
list_recommendations
********************



.. py:method:: DevOpsGuru.Client.list_recommendations(**kwargs)

  

  Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/devops-guru-2020-12-01/ListRecommendations>`_  


  **Request Syntax**
  ::

    response = client.list_recommendations(
        InsightId='string',
        NextToken='string',
        Locale='DE_DE'|'EN_US'|'EN_GB'|'ES_ES'|'FR_FR'|'IT_IT'|'JA_JP'|'KO_KR'|'PT_BR'|'ZH_CN'|'ZH_TW',
        AccountId='string'
    )
    
  :type InsightId: string
  :param InsightId: **[REQUIRED]** 

    The ID of the requested insight.

    

  
  :type NextToken: string
  :param NextToken: 

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    

  
  :type Locale: string
  :param Locale: 

    A locale that specifies the language to use for recommendations.

    

  
  :type AccountId: string
  :param AccountId: 

    The ID of the Amazon Web Services account.

    

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

    
    ::

      {
          'Recommendations': [
              {
                  'Description': 'string',
                  'Link': 'string',
                  'Name': 'string',
                  'Reason': 'string',
                  'RelatedEvents': [
                      {
                          'Name': 'string',
                          'Resources': [
                              {
                                  'Name': 'string',
                                  'Type': 'string'
                              },
                          ]
                      },
                  ],
                  'RelatedAnomalies': [
                      {
                          'Resources': [
                              {
                                  'Name': 'string',
                                  'Type': 'string'
                              },
                          ],
                          'SourceDetails': [
                              {
                                  'CloudWatchMetrics': [
                                      {
                                          'MetricName': 'string',
                                          'Namespace': 'string'
                                      },
                                  ]
                              },
                          ],
                          'AnomalyId': 'string'
                      },
                  ],
                  'Category': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Recommendations** *(list) --* 

        An array of the requested recommendations.

        
        

        - *(dict) --* 

          Recommendation information to help you remediate detected anomalous behavior that generated an insight.

          
          

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

            A description of the problem.

            
          

          - **Link** *(string) --* 

            A hyperlink to information to help you address the problem.

            
          

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

            The name of the recommendation.

            
          

          - **Reason** *(string) --* 

            The reason DevOps Guru flagged the anomalous behavior as a problem.

            
          

          - **RelatedEvents** *(list) --* 

            Events that are related to the problem. Use these events to learn more about what's happening and to help address the issue.

            
            

            - *(dict) --* 

              Information about an event that is related to a recommendation.

              
              

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

                The name of the event. This corresponds to the ``Name`` field in an ``Event`` object.

                
              

              - **Resources** *(list) --* 

                A ``ResourceCollection`` object that contains arrays of the names of Amazon Web Services CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

                
                

                - *(dict) --* 

                  Information about an Amazon Web Services resource that emitted and event that is related to a recommendation in an insight.

                  
                  

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

                    The name of the resource that emitted the event. This corresponds to the ``Name`` field in an ``EventResource`` object.

                    
                  

                  - **Type** *(string) --* 

                    The type of the resource that emitted the event. This corresponds to the ``Type`` field in an ``EventResource`` object.

                    
              
            
          
        
          

          - **RelatedAnomalies** *(list) --* 

            Anomalies that are related to the problem. Use these Anomalies to learn more about what's happening and to help address the issue.

            
            

            - *(dict) --* 

              Information about an anomaly that is related to a recommendation.

              
              

              - **Resources** *(list) --* 

                An array of objects that represent resources in which DevOps Guru detected anomalous behavior. Each object contains the name and type of the resource.

                
                

                - *(dict) --* 

                  Information about a resource in which DevOps Guru detected anomalous behavior.

                  
                  

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

                    The name of the resource.

                    
                  

                  - **Type** *(string) --* 

                    The type of the resource. Resource types take the same form that is used by Amazon Web Services CloudFormation resource type identifiers, ``service-provider::service-name::data-type-name``. For example, ``AWS::RDS::DBCluster``. For more information, see `Amazon Web Services resource and property types reference <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html>`__ in the *Amazon Web Services CloudFormation User Guide*.

                    
              
            
              

              - **SourceDetails** *(list) --* 

                Information about where the anomalous behavior related the recommendation was found. For example, details in Amazon CloudWatch metrics.

                
                

                - *(dict) --* 

                  Contains an array of ``RecommendationRelatedCloudWatchMetricsSourceDetail`` objects that contain the name and namespace of an Amazon CloudWatch metric.

                  
                  

                  - **CloudWatchMetrics** *(list) --* 

                    An array of ``CloudWatchMetricsDetail`` objects that contains information about the analyzed metrics that displayed anomalous behavior.

                    
                    

                    - *(dict) --* 

                      Information about an Amazon CloudWatch metric that is analyzed by DevOps Guru. It is one of many analyzed metrics that are used to generate insights.

                      
                      

                      - **MetricName** *(string) --* 

                        The name of the CloudWatch metric.

                        
                      

                      - **Namespace** *(string) --* 

                        The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.

                        
                  
                
              
            
              

              - **AnomalyId** *(string) --* 

                The ID of an anomaly that generated the insight with this recommendation.

                
          
        
          

          - **Category** *(string) --* 

            The category type of the recommendation.

            
      
    
      

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

        The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

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

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

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

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

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

  