Skip to content

get_detector async

get_detector(
    detector_id: DetectorId,
    *,
    config_overrides: Optional[AsyncGuardDutyClientConfig] = None,
) -> GetDetectorResponse

Retrieves a GuardDuty detector specified by the detectorId.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

Parameters:

  • detector_id (DetectorId) –

    The unique ID of the detector that you want to get.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

Raises:

Source code in docs_src/capo_guardduty/_services/async_guard_duty.py
async def get_detector(
    self,
    detector_id: "capo_guardduty.types.detector_id.DetectorId",
    *,
    config_overrides: Optional[AsyncGuardDutyClientConfig] = None,
) -> "capo_guardduty.types.get_detector_response.GetDetectorResponse":
    """<p>Retrieves a GuardDuty detector specified by the detectorId.</p> <p>There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>

    Args:
        detector_id: <p>The unique ID of the detector that you want to get.</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>

    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.get_detector_request.GetDetectorRequest]",
    ) -> AsyncOperationResponse[
        "capo_guardduty.types.get_detector_response.GetDetectorResponse"
    ]:
        import capo_guardduty._operations.guard_duty_api_service.get_detector

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDetector")
    )
    input_: capo_guardduty.types.get_detector_request.GetDetectorRequest = {
        "detector_id": detector_id
    }

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