Skip to content

update_custom_detection_rule_org_configuration

Operation

update_custom_detection_rule_org_configuration

Updates the organization-level configuration for a custom detection rule, including the mode and include/exclude account lists.

Parameters:

Name Type Description Default
request UpdateCustomDetectionRuleOrgConfigurationInput | UpdateCustomDetectionRuleOrgConfigurationInputDict | 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[UpdateCustomDetectionRuleOrgConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateCustomDetectionRuleOrgConfigurationOutput

An instance of UpdateCustomDetectionRuleOrgConfigurationOutput.

update_custom_detection_rule_org_configuration async

Updates the organization-level configuration for a custom detection rule, including the mode and include/exclude account lists.

Parameters:

Name Type Description Default
request UpdateCustomDetectionRuleOrgConfigurationInput | UpdateCustomDetectionRuleOrgConfigurationInputDict | 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[UpdateCustomDetectionRuleOrgConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateCustomDetectionRuleOrgConfigurationOutput

An instance of UpdateCustomDetectionRuleOrgConfigurationOutput.

Input

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

UpdateCustomDetectionRuleOrgConfigurationInputDict

Bases: TypedDict

Dictionary form of UpdateCustomDetectionRuleOrgConfigurationInput.

Attributes

exclude_account_ids instance-attribute
exclude_account_ids: Sequence[str] | None

The account IDs to exclude from the organization configuration. Mutually exclusive with IncludeAccountIds.

include_account_ids instance-attribute
include_account_ids: Sequence[str] | None

The account IDs to include in the organization configuration. Mutually exclusive with ExcludeAccountIds.

mode instance-attribute
mode: Required[str]

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

rule_id instance-attribute
rule_id: Required[str]

The unique identifier for the custom detection rule.

UpdateCustomDetectionRuleOrgConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for UpdateCustomDetectionRuleOrgConfigurationInput structure.

Attributes

exclude_account_ids class-attribute instance-attribute
exclude_account_ids: list[str] | None = ...

The account IDs to exclude from the organization configuration. Mutually exclusive with IncludeAccountIds.

include_account_ids class-attribute instance-attribute
include_account_ids: list[str] | None = ...

The account IDs to include in the organization configuration. Mutually exclusive with ExcludeAccountIds.

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

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

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

The unique identifier for the custom detection rule.

Output

UpdateCustomDetectionRuleOrgConfigurationOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateCustomDetectionRuleOrgConfigurationOutput 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.