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

**********************
get_lens_review_report
**********************



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

  

  Get lens review report.

  

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


  **Request Syntax**
  ::

    response = client.get_lens_review_report(
        WorkloadId='string',
        LensAlias='string',
        MilestoneNumber=123
    )
    
  :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 MilestoneNumber: integer
  :param MilestoneNumber: 

    The milestone number.

     

    A workload can have a maximum of 100 milestones.

    

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

    
    ::

      {
          'WorkloadId': 'string',
          'MilestoneNumber': 123,
          'LensReviewReport': {
              'LensAlias': 'string',
              'LensArn': 'string',
              'Base64String': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Output of a get lens review report 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.

        
      

      - **LensReviewReport** *(dict) --* 

        A report of a lens review.

        
        

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

          
        

        - **Base64String** *(string) --* 

          The Base64-encoded string representation of a lens review report.

           

          This data can be used to create a PDF file.

           

          Only returned by  GetConsolidatedReport when ``PDF`` format is requested.

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

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

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

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

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

  