Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetAssessmentReport

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

Request Syntax


{
   "assessmentRunArn": "string",
   "reportFileFormat": "string",
   "reportType": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

assessmentRunArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 300.

Required: Yes

reportFileFormat

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

Type: String

Valid Values: HTML | PDF

Required: Yes

reportType

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.

Type: String

Valid Values: FINDING | FULL

Required: Yes

Response Syntax


{
   "status": "string",
   "url": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

status

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

Type: String

Valid Values: WORK_IN_PROGRESS | FAILED | COMPLETED

url

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

Type: String

Length Constraints: Maximum length of 2048.

Errors

For information about the errors that are common to all actions, see Common Errors.

AssessmentRunInProgressException

You cannot perform a specified action if an assessment run is currently in progress.

HTTP Status Code: 400

InternalException

Internal server error.

HTTP Status Code: 500

InvalidInputException

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

HTTP Status Code: 400

NoSuchEntityException

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

HTTP Status Code: 400

ServiceTemporarilyUnavailableException

The serice is temporary unavailable.

HTTP Status Code: 400

UnsupportedFeatureException

Used by the GetAssessmentReport API. The request was rejected because you tried to generate a report for an assessment run that existed before reporting was supported in Amazon Inspector. You can only generate reports for assessment runs that took place or will take place after generating reports in Amazon Inspector Classic became available.

HTTP Status Code: 400