Skip to content

GuardDuty  >  Operations  >  get_custom_detection_rule

get_custom_detection_rule

Operation

get_custom_detection_rule async 

get_custom_detection_rule(input: GetCustomDetectionRuleInput, plugins: list[Plugin] | None = None) -> GetCustomDetectionRuleOutput

Returns details for a custom detection rule in GuardDuty, including its detection logic.

Parameters:

Name Type Description Default
input GetCustomDetectionRuleInput

An instance of GetCustomDetectionRuleInput.

 required
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

Returns:

Type Description
GetCustomDetectionRuleOutput

An instance of GetCustomDetectionRuleOutput.

Input

GetCustomDetectionRuleInput dataclass

Dataclass for GetCustomDetectionRuleInput structure.

Attributes

rule_id class-attribute instance-attribute 
rule_id: str | None = None

The unique identifier for the custom detection rule.

Output

GetCustomDetectionRuleOutput dataclass

Dataclass for GetCustomDetectionRuleOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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.

rule class-attribute instance-attribute 
rule: RuleDetail | None = None

The details of the custom detection rule.