archive_findings `async` ¶

archive_findings(
    detector_id: DetectorId,
    *,
    config_overrides: Optional[AsyncGuardDutyClientConfig] = None,
    finding_ids: Optional[FindingIds] = None,
) -> ArchiveFindingsResponse

Archives GuardDuty findings that are specified by the list of finding IDs.

Only the administrator account can archive findings. Member accounts don't have permission to archive findings from their accounts.

Parameters:

detector_id (DetectorId) –

The ID of the detector that specifies the GuardDuty service whose findings you want to archive.

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 that you want to archive.

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/async_guard_duty.py

async def archive_findings(
    self,
    detector_id: "capo_guardduty.types.detector_id.DetectorId",
    *,
    config_overrides: Optional[AsyncGuardDutyClientConfig] = None,
    finding_ids: Optional["capo_guardduty.types.finding_ids.FindingIds"] = None,
) -> "capo_guardduty.types.archive_findings_response.ArchiveFindingsResponse":
    """<p>Archives GuardDuty findings that are specified by the list of finding IDs.</p> <note> <p>Only the administrator account can archive findings. Member accounts don't have permission to archive findings from their accounts.</p> </note>

    Args:
        detector_id: <p>The ID of the detector that specifies the GuardDuty service whose findings you want to archive.</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 that you want to archive.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_guardduty.types.archive_findings_request.ArchiveFindingsRequest]",
    ) -> AsyncOperationResponse[
        "capo_guardduty.types.archive_findings_response.ArchiveFindingsResponse"
    ]:
        import capo_guardduty._operations.guard_duty_api_service.archive_findings

        (
            output,
            http_response,
        ) = await capo_guardduty._operations.guard_duty_api_service.archive_findings.async_archive_findings(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

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

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

archive_findings async ¶

archive_findings `async` ¶