Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.
- getAssessmentReport :: Text -> ReportFileFormat -> ReportType -> GetAssessmentReport
- data GetAssessmentReport
- garAssessmentRunARN :: Lens' GetAssessmentReport Text
- garReportFileFormat :: Lens' GetAssessmentReport ReportFileFormat
- garReportType :: Lens' GetAssessmentReport ReportType
- getAssessmentReportResponse :: Int -> ReportStatus -> GetAssessmentReportResponse
- data GetAssessmentReportResponse
- garrsUrl :: Lens' GetAssessmentReportResponse (Maybe Text)
- garrsResponseStatus :: Lens' GetAssessmentReportResponse Int
- garrsStatus :: Lens' GetAssessmentReportResponse ReportStatus
Creating a Request
Creates a value of GetAssessmentReport
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
garAssessmentRunARN
- The ARN that specifies the assessment run for which you want to generate a report.garReportFileFormat
- Specifies the file format (html or pdf) of the assessment report that you want to generate.garReportType
- 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 .
data GetAssessmentReport Source #
See: getAssessmentReport
smart constructor.
Request Lenses
garAssessmentRunARN :: Lens' GetAssessmentReport Text Source #
The ARN that specifies the assessment run for which you want to generate a report.
garReportFileFormat :: Lens' GetAssessmentReport ReportFileFormat Source #
Specifies the file format (html or pdf) of the assessment report that you want to generate.
garReportType :: Lens' GetAssessmentReport ReportType Source #
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 .
Destructuring the Response
getAssessmentReportResponse Source #
Creates a value of GetAssessmentReportResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
garrsUrl
- Specifies the URL where you can find the generated assessment report. This parameter is only returned if the report is successfully generated.garrsResponseStatus
- -- | The response status code.garrsStatus
- Specifies the status of the request to generate an assessment report.
data GetAssessmentReportResponse Source #
See: getAssessmentReportResponse
smart constructor.
Response Lenses
garrsUrl :: Lens' GetAssessmentReportResponse (Maybe Text) Source #
Specifies the URL where you can find the generated assessment report. This parameter is only returned if the report is successfully generated.
garrsResponseStatus :: Lens' GetAssessmentReportResponse Int Source #
- - | The response status code.
garrsStatus :: Lens' GetAssessmentReportResponse ReportStatus Source #
Specifies the status of the request to generate an assessment report.