list_custom_detection_rules¶
Operation¶
list_custom_detection_rules
¶
list_custom_detection_rules(request: ListCustomDetectionRulesInput | ListCustomDetectionRulesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListCustomDetectionRulesInputDict]) -> ListCustomDetectionRulesOutput
Returns all available custom detection rules in GuardDuty. You can filter the results by data source, severity, tactic, technique, and service.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListCustomDetectionRulesInput | ListCustomDetectionRulesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ListCustomDetectionRulesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListCustomDetectionRulesOutput
|
An instance of |
list_custom_detection_rules
async
¶
list_custom_detection_rules(request: ListCustomDetectionRulesInput | ListCustomDetectionRulesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListCustomDetectionRulesInputDict]) -> ListCustomDetectionRulesOutput
Returns all available custom detection rules in GuardDuty. You can filter the results by data source, severity, tactic, technique, and service.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListCustomDetectionRulesInput | ListCustomDetectionRulesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ListCustomDetectionRulesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListCustomDetectionRulesOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListCustomDetectionRulesInputDict
¶
Bases: TypedDict
Dictionary form of ListCustomDetectionRulesInput.
Attributes¶
filters
instance-attribute
¶
filters: Sequence[DetectionRuleFilter | DetectionRuleFilterDict] | None
A list of filter criteria to apply when listing custom detection rules.
ListCustomDetectionRulesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListCustomDetectionRulesInput structure.
Attributes¶
filters
class-attribute
instance-attribute
¶
filters: list[DetectionRuleFilter] | None = ...
A list of filter criteria to apply when listing custom detection rules.
Output¶
ListCustomDetectionRulesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListCustomDetectionRulesOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
A pagination token to retrieve the next page of results. If this field is empty, there are no additional results.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
rules
class-attribute
instance-attribute
¶
rules: list[RuleSummary] | None = ...
A list of custom detection rule summaries.