Skip to content

create_custom_detection_rule_org_configuration

Operation

create_custom_detection_rule_org_configuration

Creates an organization-level configuration that enables a custom detection rule across your organization. This operation is available only to the delegated administrator account.

Parameters:

Name Type Description Default
request CreateCustomDetectionRuleOrgConfigurationInput | CreateCustomDetectionRuleOrgConfigurationInputDict | 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[CreateCustomDetectionRuleOrgConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateCustomDetectionRuleOrgConfigurationOutput

An instance of CreateCustomDetectionRuleOrgConfigurationOutput.

create_custom_detection_rule_org_configuration async

Creates an organization-level configuration that enables a custom detection rule across your organization. This operation is available only to the delegated administrator account.

Parameters:

Name Type Description Default
request CreateCustomDetectionRuleOrgConfigurationInput | CreateCustomDetectionRuleOrgConfigurationInputDict | 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[CreateCustomDetectionRuleOrgConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateCustomDetectionRuleOrgConfigurationOutput

An instance of CreateCustomDetectionRuleOrgConfigurationOutput.

Input

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

CreateCustomDetectionRuleOrgConfigurationInputDict

Bases: TypedDict

Dictionary form of CreateCustomDetectionRuleOrgConfigurationInput.

Attributes

client_token instance-attribute
client_token: str | None

A unique, case-sensitive identifier to ensure that the operation completes no more than one time.

This field is autopopulated if not provided.

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.

CreateCustomDetectionRuleOrgConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for CreateCustomDetectionRuleOrgConfigurationInput structure.

Attributes

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

A unique, case-sensitive identifier to ensure that the operation completes no more than one time.

This field is autopopulated if not provided.

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

CreateCustomDetectionRuleOrgConfigurationOutput dataclass

Bases: _SerdeShape

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