Returns all available custom detection rules in GuardDuty. You can filter the results by data source, severity, tactic, technique, and service.
Parameters:
-
max_results
(Optional[DetectionRuleMaxResults], default:
None
)
–
The maximum number of results to return in a single page. Minimum value of 1, maximum value of 100.
-
next_token
(Optional[String], default:
None
)
–
A pagination token from a previous response. Use this token to retrieve the next page of results.
-
filters
(Optional[DetectionRuleFilterList], default:
None
)
–
A list of filter criteria to apply when listing custom detection rules.
Raises:
Source code in docs_src/capo_guardduty/_services/guard_duty.py
| def list_custom_detection_rules(
self,
*,
config_overrides: Optional[GuardDutyClientConfig] = None,
max_results: Optional[
"capo_guardduty.types.detection_rule_max_results.DetectionRuleMaxResults"
] = None,
next_token: Optional["capo_guardduty.types.string.String"] = None,
filters: Optional[
"capo_guardduty.types.detection_rule_filter_list.DetectionRuleFilterList"
] = None,
) -> "capo_guardduty.types.list_custom_detection_rules_response.ListCustomDetectionRulesResponse":
"""<p>Returns all available custom detection rules in GuardDuty. You can filter the results by data source, severity, tactic, technique, and service.</p>
Args:
max_results: <p>The maximum number of results to return in a single page. Minimum value of 1, maximum value of 100.</p>
next_token: <p>A pagination token from a previous response. Use this token to retrieve the next page of results.</p>
filters: <p>A list of filter criteria to apply when listing custom detection rules.</p>
Raises:
capo_guardduty.errors.access_denied_exception.AccessDeniedException: <p>An access denied exception object.</p>
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_custom_detection_rules_request.ListCustomDetectionRulesRequest]",
) -> OperationResponse[
"capo_guardduty.types.list_custom_detection_rules_response.ListCustomDetectionRulesResponse"
]:
import capo_guardduty._operations.guard_duty_api_service.list_custom_detection_rules
output, http_response = (
capo_guardduty._operations.guard_duty_api_service.list_custom_detection_rules.list_custom_detection_rules(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListCustomDetectionRules")
)
input_: capo_guardduty.types.list_custom_detection_rules_request.ListCustomDetectionRulesRequest = {}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
if filters is not None:
input_["filters"] = filters
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|