| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.AuditManager.CreateAssessmentReport
Description
Creates an assessment report for the specified assessment.
Synopsis
- data CreateAssessmentReport = CreateAssessmentReport' {
- description :: Maybe Text
- queryStatement :: Maybe Text
- name :: Text
- assessmentId :: Text
- newCreateAssessmentReport :: Text -> Text -> CreateAssessmentReport
- createAssessmentReport_description :: Lens' CreateAssessmentReport (Maybe Text)
- createAssessmentReport_queryStatement :: Lens' CreateAssessmentReport (Maybe Text)
- createAssessmentReport_name :: Lens' CreateAssessmentReport Text
- createAssessmentReport_assessmentId :: Lens' CreateAssessmentReport Text
- data CreateAssessmentReportResponse = CreateAssessmentReportResponse' {}
- newCreateAssessmentReportResponse :: Int -> CreateAssessmentReportResponse
- createAssessmentReportResponse_assessmentReport :: Lens' CreateAssessmentReportResponse (Maybe AssessmentReport)
- createAssessmentReportResponse_httpStatus :: Lens' CreateAssessmentReportResponse Int
Creating a Request
data CreateAssessmentReport Source #
See: newCreateAssessmentReport smart constructor.
Constructors
| CreateAssessmentReport' | |
Fields
| |
Instances
newCreateAssessmentReport Source #
Create a value of CreateAssessmentReport with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateAssessmentReport, createAssessmentReport_description - The description of the assessment report.
$sel:queryStatement:CreateAssessmentReport', createAssessmentReport_queryStatement - A SQL statement that represents an evidence finder query.
Provide this parameter when you want to generate an assessment report from the results of an evidence finder search query. When you use this parameter, Audit Manager generates a one-time report using only the evidence from the query output. This report does not include any assessment evidence that was manually added to a report using the console, or associated with a report using the API.
To use this parameter, the
enablementStatus
of evidence finder must be ENABLED.
For examples and help resolving queryStatement validation exceptions,
see
Troubleshooting evidence finder issues
in the Audit Manager User Guide.
CreateAssessmentReport, createAssessmentReport_name - The name of the new assessment report.
CreateAssessmentReport, createAssessmentReport_assessmentId - The identifier for the assessment.
Request Lenses
createAssessmentReport_description :: Lens' CreateAssessmentReport (Maybe Text) Source #
The description of the assessment report.
createAssessmentReport_queryStatement :: Lens' CreateAssessmentReport (Maybe Text) Source #
A SQL statement that represents an evidence finder query.
Provide this parameter when you want to generate an assessment report from the results of an evidence finder search query. When you use this parameter, Audit Manager generates a one-time report using only the evidence from the query output. This report does not include any assessment evidence that was manually added to a report using the console, or associated with a report using the API.
To use this parameter, the
enablementStatus
of evidence finder must be ENABLED.
For examples and help resolving queryStatement validation exceptions,
see
Troubleshooting evidence finder issues
in the Audit Manager User Guide.
createAssessmentReport_name :: Lens' CreateAssessmentReport Text Source #
The name of the new assessment report.
createAssessmentReport_assessmentId :: Lens' CreateAssessmentReport Text Source #
The identifier for the assessment.
Destructuring the Response
data CreateAssessmentReportResponse Source #
See: newCreateAssessmentReportResponse smart constructor.
Constructors
| CreateAssessmentReportResponse' | |
Fields
| |
Instances
newCreateAssessmentReportResponse Source #
Create a value of CreateAssessmentReportResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assessmentReport:CreateAssessmentReportResponse', createAssessmentReportResponse_assessmentReport - The new assessment report that the CreateAssessmentReport API
returned.
$sel:httpStatus:CreateAssessmentReportResponse', createAssessmentReportResponse_httpStatus - The response's http status code.
Response Lenses
createAssessmentReportResponse_assessmentReport :: Lens' CreateAssessmentReportResponse (Maybe AssessmentReport) Source #
The new assessment report that the CreateAssessmentReport API
returned.
createAssessmentReportResponse_httpStatus :: Lens' CreateAssessmentReportResponse Int Source #
The response's http status code.