:doc:`Inspector <../../inspector>` / Client / get_assessment_report

*********************
get_assessment_report
*********************



.. py:method:: Inspector.Client.get_assessment_report(**kwargs)

  

  Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/GetAssessmentReport>`_  


  **Request Syntax**
  ::

    response = client.get_assessment_report(
        assessmentRunArn='string',
        reportFileFormat='HTML'|'PDF',
        reportType='FINDING'|'FULL'
    )
    
  :type assessmentRunArn: string
  :param assessmentRunArn: **[REQUIRED]** 

    The ARN that specifies the assessment run for which you want to generate a report.

    

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

    Specifies the file format (html or pdf) of the assessment report that you want to generate.

    

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

    Specifies the type of the assessment report that you want to generate. There are two types of assessment reports: a finding report and a full report. For more information, see `Assessment Reports <https://docs.aws.amazon.com/inspector/latest/userguide/inspector_reports.html>`__.

    

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

    
    ::

      {
          'status': 'WORK_IN_PROGRESS'|'FAILED'|'COMPLETED',
          'url': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **status** *(string) --* 

        Specifies the status of the request to generate an assessment report.

        
      

      - **url** *(string) --* 

        Specifies the URL where you can find the generated assessment report. This parameter is only returned if the report is successfully generated.

        
  
  **Exceptions**
  
  *   :py:class:`Inspector.Client.exceptions.InternalException`

  
  *   :py:class:`Inspector.Client.exceptions.InvalidInputException`

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

  
  *   :py:class:`Inspector.Client.exceptions.NoSuchEntityException`

  
  *   :py:class:`Inspector.Client.exceptions.AssessmentRunInProgressException`

  
  *   :py:class:`Inspector.Client.exceptions.UnsupportedFeatureException`

  
  *   :py:class:`Inspector.Client.exceptions.ServiceTemporarilyUnavailableException`

  