unarchive_findings ¶

unarchive_findings(
    detector_id: DetectorId,
    *,
    config_overrides: Optional[GuardDutyClientConfig] = None,
    finding_ids: Optional[FindingIds] = None,
) -> UnarchiveFindingsResponse

Unarchives GuardDuty findings specified by the findingIds.

Parameters:

detector_id (DetectorId) –

The ID of the detector associated with the findings to unarchive.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
finding_ids (Optional[FindingIds], default: None ) –

The IDs of the findings to unarchive.

Raises:

BadRequestException –

A bad request exception object.
InternalServerErrorException –

An internal server error exception object.
UnknownServiceError –

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

Source code in docs_src/capo_guardduty/_services/guard_duty.py

def unarchive_findings(
    self,
    detector_id: "capo_guardduty.types.detector_id.DetectorId",
    *,
    config_overrides: Optional[GuardDutyClientConfig] = None,
    finding_ids: Optional["capo_guardduty.types.finding_ids.FindingIds"] = None,
) -> "capo_guardduty.types.unarchive_findings_response.UnarchiveFindingsResponse":
    """<p>Unarchives GuardDuty findings specified by the <code>findingIds</code>.</p>

    Args:
        detector_id: <p>The ID of the detector associated with the findings to unarchive.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
        finding_ids: <p>The IDs of the findings to unarchive.</p>

    Raises:
        capo_guardduty.errors.bad_request_exception.BadRequestException: <p>A bad request exception object.</p>
        capo_guardduty.errors.internal_server_error_exception.InternalServerErrorException: <p>An internal server error exception object.</p>
        capo_guardduty.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_guardduty.types.unarchive_findings_request.UnarchiveFindingsRequest]",
    ) -> OperationResponse[
        "capo_guardduty.types.unarchive_findings_response.UnarchiveFindingsResponse"
    ]:
        import capo_guardduty._operations.guard_duty_api_service.unarchive_findings

        output, http_response = (
            capo_guardduty._operations.guard_duty_api_service.unarchive_findings.unarchive_findings(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UnarchiveFindings")
    )
    input_: capo_guardduty.types.unarchive_findings_request.UnarchiveFindingsRequest = {
        "detector_id": detector_id
    }
    if finding_ids is not None:
        input_["finding_ids"] = finding_ids

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