create_findings_report ¶

create_findings_report(
    report_format: ReportFormat,
    s3_destination: Destination,
    *,
    config_overrides: Optional[Inspector2ClientConfig] = None,
    filter_criteria: Optional[FilterCriteria] = None,
) -> CreateFindingsReportResponse

Creates a finding report. By default only ACTIVE findings are returned in the report. To see SUPRESSED or CLOSED findings you must specify a value for the findingStatus filter criteria.

Parameters:

filter_criteria (Optional[FilterCriteria], default: None ) –

The filter criteria to apply to the results of the finding report.
report_format (ReportFormat) –

The format to generate the report in.
s3_destination (Destination) –

The Amazon S3 export destination for the report.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.
InternalServerException –

The request has failed due to an internal failure of the Amazon Inspector service.
ResourceNotFoundException –

The operation tried to access an invalid resource. Make sure the resource is specified correctly.
ThrottlingException –

The limit on the number of requests per second was exceeded.
ValidationException –

The request has failed validation due to missing required fields or having invalid inputs.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_inspector2/_services/inspector2.py

def create_findings_report(
    self,
    report_format: "capo_inspector2.types.report_format.ReportFormat",
    s3_destination: "capo_inspector2.types.destination.Destination",
    *,
    config_overrides: Optional[Inspector2ClientConfig] = None,
    filter_criteria: Optional[
        "capo_inspector2.types.filter_criteria.FilterCriteria"
    ] = None,
) -> "capo_inspector2.types.create_findings_report_response.CreateFindingsReportResponse":
    """<p>Creates a finding report. By default only <code>ACTIVE</code> findings are returned in the report. To see <code>SUPRESSED</code> or <code>CLOSED</code> findings you must specify a value for the <code>findingStatus</code> filter criteria. </p>

    Args:
        filter_criteria: <p>The filter criteria to apply to the results of the finding report.</p>
        report_format: <p>The format to generate the report in.</p>
        s3_destination: <p>The Amazon S3 export destination for the report.</p>

    Raises:
        capo_inspector2.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p> <p> For <code>Enable</code>, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region. </p>
        capo_inspector2.errors.internal_server_exception.InternalServerException: <p>The request has failed due to an internal failure of the Amazon Inspector service.</p>
        capo_inspector2.errors.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access an invalid resource. Make sure the resource is specified correctly.</p>
        capo_inspector2.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded.</p>
        capo_inspector2.errors.validation_exception.ValidationException: <p>The request has failed validation due to missing required fields or having invalid inputs.</p>
        capo_inspector2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_inspector2.types.create_findings_report_request.CreateFindingsReportRequest]",
    ) -> OperationResponse[
        "capo_inspector2.types.create_findings_report_response.CreateFindingsReportResponse"
    ]:
        import capo_inspector2._operations.inspector2.create_findings_report

        output, http_response = (
            capo_inspector2._operations.inspector2.create_findings_report.create_findings_report(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateFindingsReport")
    )
    input_: capo_inspector2.types.create_findings_report_request.CreateFindingsReportRequest = {
        "report_format": report_format,
        "s3_destination": s3_destination,
    }
    if filter_criteria is not None:
        input_["filter_criteria"] = filter_criteria

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output