Skip to content

GuardDuty  >  Operations  >  get_custom_detection_rule_org_configuration

get_custom_detection_rule_org_configuration

Operation

get_custom_detection_rule_org_configuration async 

get_custom_detection_rule_org_configuration(input: GetCustomDetectionRuleOrgConfigurationInput, plugins: list[Plugin] | None = None) -> GetCustomDetectionRuleOrgConfigurationOutput

Returns the organization-level configuration for a custom detection rule.

Parameters:

Name Type Description Default
input GetCustomDetectionRuleOrgConfigurationInput

An instance of GetCustomDetectionRuleOrgConfigurationInput.

 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
GetCustomDetectionRuleOrgConfigurationOutput

An instance of GetCustomDetectionRuleOrgConfigurationOutput.

Input

GetCustomDetectionRuleOrgConfigurationInput dataclass

Dataclass for GetCustomDetectionRuleOrgConfigurationInput structure.

Attributes

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

The execution mode of the organization configuration to retrieve. Valid values: LIVE | DRY_RUN.

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

The unique identifier for the custom detection rule.

Output

GetCustomDetectionRuleOrgConfigurationOutput dataclass

Dataclass for GetCustomDetectionRuleOrgConfigurationOutput structure.

Attributes

configuration class-attribute instance-attribute 
configuration: DetectionRuleOrgConfiguration | None = None

The details of the organization configuration.

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.