get_assessment_report `async` ¶

get_assessment_report(
    assessment_run_arn: Arn,
    report_file_format: ReportFileFormat,
    report_type: ReportType,
    *,
    config_overrides: Optional[AsyncInspectorClientConfig] = None,
) -> GetAssessmentReportResponse

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

Parameters:

assessment_run_arn (Arn) –

The ARN that specifies the assessment run for which you want to generate a report.
report_file_format (ReportFileFormat) –

Specifies the file format (html or pdf) of the assessment report that you want to generate.
report_type (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.

Raises:

AccessDeniedException –

You do not have required permissions to access the requested resource.
AssessmentRunInProgressException –

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

Internal server error.
InvalidInputException –

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

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

The serice is temporary unavailable.
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 became available.
UnknownServiceError –

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

Source code in docs_src/capo_inspector/_services/async_inspector.py

async def get_assessment_report(
    self,
    assessment_run_arn: "capo_inspector.types.arn.Arn",
    report_file_format: "capo_inspector.types.report_file_format.ReportFileFormat",
    report_type: "capo_inspector.types.report_type.ReportType",
    *,
    config_overrides: Optional[AsyncInspectorClientConfig] = None,
) -> "capo_inspector.types.get_assessment_report_response.GetAssessmentReportResponse":
    """<p>Produces an assessment report that includes detailed and comprehensive results of a specified assessment run. </p>

    Args:
        assessment_run_arn: <p>The ARN that specifies the assessment run for which you want to generate a report.</p>
        report_file_format: <p>Specifies the file format (html or pdf) of the assessment report that you want to generate.</p>
        report_type: <p>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 <a href="https://docs.aws.amazon.com/inspector/latest/userguide/inspector_reports.html">Assessment Reports</a>. </p>

    Raises:
        capo_inspector.errors.access_denied_exception.AccessDeniedException: <p>You do not have required permissions to access the requested resource.</p>
        capo_inspector.errors.assessment_run_in_progress_exception.AssessmentRunInProgressException: <p>You cannot perform a specified action if an assessment run is currently in progress.</p>
        capo_inspector.errors.internal_exception.InternalException: <p>Internal server error.</p>
        capo_inspector.errors.invalid_input_exception.InvalidInputException: <p>The request was rejected because an invalid or out-of-range value was supplied for an input parameter.</p>
        capo_inspector.errors.no_such_entity_exception.NoSuchEntityException: <p>The request was rejected because it referenced an entity that does not exist. The error code describes the entity.</p>
        capo_inspector.errors.service_temporarily_unavailable_exception.ServiceTemporarilyUnavailableException: <p>The serice is temporary unavailable.</p>
        capo_inspector.errors.unsupported_feature_exception.UnsupportedFeatureException: <p>Used by the <a>GetAssessmentReport</a> 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 became available.</p>
        capo_inspector.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_inspector.types.get_assessment_report_request.GetAssessmentReportRequest]",
    ) -> AsyncOperationResponse[
        "capo_inspector.types.get_assessment_report_response.GetAssessmentReportResponse"
    ]:
        import capo_inspector._operations.inspector_service.get_assessment_report

        (
            output,
            http_response,
        ) = await capo_inspector._operations.inspector_service.get_assessment_report.async_get_assessment_report(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAssessmentReport")
    )
    input_: capo_inspector.types.get_assessment_report_request.GetAssessmentReportRequest = {
        "assessment_run_arn": assessment_run_arn,
        "report_file_format": report_file_format,
        "report_type": report_type,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_assessment_report async ¶

get_assessment_report `async` ¶