Skip to content

get_custom_detection_rule

Operation

get_custom_detection_rule

get_custom_detection_rule(request: GetCustomDetectionRuleInput | GetCustomDetectionRuleInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetCustomDetectionRuleInputDict]) -> GetCustomDetectionRuleOutput

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

Parameters:

Name Type Description Default
request GetCustomDetectionRuleInput | GetCustomDetectionRuleInputDict | 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[GetCustomDetectionRuleInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetCustomDetectionRuleOutput

An instance of GetCustomDetectionRuleOutput.

get_custom_detection_rule async

get_custom_detection_rule(request: GetCustomDetectionRuleInput | GetCustomDetectionRuleInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetCustomDetectionRuleInputDict]) -> GetCustomDetectionRuleOutput

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

Parameters:

Name Type Description Default
request GetCustomDetectionRuleInput | GetCustomDetectionRuleInputDict | 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[GetCustomDetectionRuleInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetCustomDetectionRuleOutput

An instance of GetCustomDetectionRuleOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetCustomDetectionRuleInputDict

Bases: TypedDict

Dictionary form of GetCustomDetectionRuleInput.

Attributes

rule_id instance-attribute
rule_id: Required[str]

The unique identifier for the custom detection rule.

GetCustomDetectionRuleInput dataclass

Bases: _SerdeShape

Dataclass for GetCustomDetectionRuleInput structure.

Attributes

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

The unique identifier for the custom detection rule.

Output

GetCustomDetectionRuleOutput dataclass

Bases: _SerdeShape

Dataclass for GetCustomDetectionRuleOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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 = ...

The details of the custom detection rule.