Skip to content

list_detectors

list_detectors(
    *,
    config_overrides: Optional[GuardDutyClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[String] = None,
) -> ListDetectorsResponse

Lists detectorIds of all the existing Amazon GuardDuty detector resources.

Parameters:

  • max_results (Optional[MaxResults], default: None ) –

    You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.

  • next_token (Optional[String], default: None ) –

    You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

Raises:

Source code in docs_src/capo_guardduty/_services/guard_duty.py
def list_detectors(
    self,
    *,
    config_overrides: Optional[GuardDutyClientConfig] = None,
    max_results: Optional["capo_guardduty.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_guardduty.types.string.String"] = None,
) -> "capo_guardduty.types.list_detectors_response.ListDetectorsResponse":
    """<p>Lists detectorIds of all the existing Amazon GuardDuty detector resources.</p>

    Args:
        max_results: <p>You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.</p>
        next_token: <p>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.</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.list_detectors_request.ListDetectorsRequest]",
    ) -> OperationResponse[
        "capo_guardduty.types.list_detectors_response.ListDetectorsResponse"
    ]:
        import capo_guardduty._operations.guard_duty_api_service.list_detectors

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDetectors")
    )
    input_: capo_guardduty.types.list_detectors_request.ListDetectorsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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