Skip to content

get_custom_detection_rule_org_configuration

Operation

get_custom_detection_rule_org_configuration

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

Parameters:

Name Type Description Default
request GetCustomDetectionRuleOrgConfigurationInput | GetCustomDetectionRuleOrgConfigurationInputDict | 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[GetCustomDetectionRuleOrgConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetCustomDetectionRuleOrgConfigurationOutput

An instance of GetCustomDetectionRuleOrgConfigurationOutput.

get_custom_detection_rule_org_configuration async

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

Parameters:

Name Type Description Default
request GetCustomDetectionRuleOrgConfigurationInput | GetCustomDetectionRuleOrgConfigurationInputDict | 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[GetCustomDetectionRuleOrgConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetCustomDetectionRuleOrgConfigurationOutput

An instance of GetCustomDetectionRuleOrgConfigurationOutput.

Input

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

GetCustomDetectionRuleOrgConfigurationInputDict

Bases: TypedDict

Dictionary form of GetCustomDetectionRuleOrgConfigurationInput.

Attributes

mode instance-attribute
mode: Required[str]

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

rule_id instance-attribute
rule_id: Required[str]

The unique identifier for the custom detection rule.

GetCustomDetectionRuleOrgConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for GetCustomDetectionRuleOrgConfigurationInput structure.

Attributes

mode class-attribute instance-attribute
mode: str | 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 = ...

The unique identifier for the custom detection rule.

Output

GetCustomDetectionRuleOrgConfigurationOutput dataclass

Bases: _SerdeShape

Dataclass for GetCustomDetectionRuleOrgConfigurationOutput structure.

Attributes

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

The details of the organization configuration.

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.