:doc:`WellArchitected <../../wellarchitected>` / Client / list_lens_review_improvements

*****************************
list_lens_review_improvements
*****************************



.. py:method:: WellArchitected.Client.list_lens_review_improvements(**kwargs)

  

  List the improvements of a particular lens review.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensReviewImprovements>`_  


  **Request Syntax**
  ::

    response = client.list_lens_review_improvements(
        WorkloadId='string',
        LensAlias='string',
        PillarId='string',
        MilestoneNumber=123,
        NextToken='string',
        MaxResults=123,
        QuestionPriority='PRIORITIZED'|'NONE'
    )
    
  :type WorkloadId: string
  :param WorkloadId: **[REQUIRED]** 

    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    

  
  :type LensAlias: string
  :param LensAlias: **[REQUIRED]** 

    The alias of the lens.

     

    For Amazon Web Services official lenses, this is either the lens alias, such as ``serverless``, or the lens ARN, such as ``arn:aws:wellarchitected:us-east-1::lens/serverless``. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

     

    For custom lenses, this is the lens ARN, such as ``arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef``.

     

    Each lens is identified by its  LensSummary$LensAlias.

    

  
  :type PillarId: string
  :param PillarId: 

    The ID used to identify a pillar, for example, ``security``.

     

    A pillar is identified by its  PillarReviewSummary$PillarId.

    

  
  :type MilestoneNumber: integer
  :param MilestoneNumber: 

    The milestone number.

     

    A workload can have a maximum of 100 milestones.

    

  
  :type NextToken: string
  :param NextToken: 

    The token to use to retrieve the next set of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return for this request.

    

  
  :type QuestionPriority: string
  :param QuestionPriority: 

    The priority of the question.

    

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

    
    ::

      {
          'WorkloadId': 'string',
          'MilestoneNumber': 123,
          'LensAlias': 'string',
          'LensArn': 'string',
          'ImprovementSummaries': [
              {
                  'QuestionId': 'string',
                  'PillarId': 'string',
                  'QuestionTitle': 'string',
                  'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE',
                  'ImprovementPlanUrl': 'string',
                  'ImprovementPlans': [
                      {
                          'ChoiceId': 'string',
                          'DisplayText': 'string',
                          'ImprovementPlanUrl': 'string'
                      },
                  ],
                  'JiraConfiguration': {
                      'JiraIssueUrl': 'string',
                      'LastSyncedTime': datetime(2015, 1, 1)
                  }
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Output of a list lens review improvements call.

      
      

      - **WorkloadId** *(string) --* 

        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

        
      

      - **MilestoneNumber** *(integer) --* 

        The milestone number.

         

        A workload can have a maximum of 100 milestones.

        
      

      - **LensAlias** *(string) --* 

        The alias of the lens.

         

        For Amazon Web Services official lenses, this is either the lens alias, such as ``serverless``, or the lens ARN, such as ``arn:aws:wellarchitected:us-east-1::lens/serverless``. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

         

        For custom lenses, this is the lens ARN, such as ``arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef``.

         

        Each lens is identified by its  LensSummary$LensAlias.

        
      

      - **LensArn** *(string) --* 

        The ARN for the lens.

        
      

      - **ImprovementSummaries** *(list) --* 

        List of improvement summaries of lens review in a workload.

        
        

        - *(dict) --* 

          An improvement summary of a lens review in a workload.

          
          

          - **QuestionId** *(string) --* 

            The ID of the question.

            
          

          - **PillarId** *(string) --* 

            The ID used to identify a pillar, for example, ``security``.

             

            A pillar is identified by its  PillarReviewSummary$PillarId.

            
          

          - **QuestionTitle** *(string) --* 

            The title of the question.

            
          

          - **Risk** *(string) --* 

            The risk for a given workload, lens review, pillar, or question.

            
          

          - **ImprovementPlanUrl** *(string) --* 

            The improvement plan URL for a question in an Amazon Web Services official lenses.

             

            This value is only available if the question has been answered.

             

            This value does not apply to custom lenses.

            
          

          - **ImprovementPlans** *(list) --* 

            The improvement plan details.

            
            

            - *(dict) --* 

              The choice level improvement plan.

              
              

              - **ChoiceId** *(string) --* 

                The ID of a choice.

                
              

              - **DisplayText** *(string) --* 

                The display text for the improvement plan.

                
              

              - **ImprovementPlanUrl** *(string) --* 

                The improvement plan URL for a question in an Amazon Web Services official lenses.

                 

                This value is only available if the question has been answered.

                 

                This value does not apply to custom lenses.

                
          
        
          

          - **JiraConfiguration** *(dict) --* 

            Configuration of the Jira integration.

            
            

            - **JiraIssueUrl** *(string) --* 

              The URL of the associated Jira issue.

              
            

            - **LastSyncedTime** *(datetime) --* 

              The date and time recorded.

              
        
      
    
      

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

        The token to use to retrieve the next set of results.

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

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

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

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

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

  