Inspector / Client / get_assessment_report

get_assessment_report#

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

Request Syntax

response = client.get_assessment_report(
    assessmentRunArn='string',
    reportFileFormat='HTML'|'PDF',
    reportType='FINDING'|'FULL'
)
Parameters:

  • assessmentRunArn (string) –

    [REQUIRED]

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

  • reportFileFormat (string) –

    [REQUIRED]

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

  • reportType (string) –

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

Return type:

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