Skip to content

create_custom_detection_rule_association

Operation

create_custom_detection_rule_association

Enables a custom detection rule for your account by creating an association. You specify the rule and the mode in which it operates.

Parameters:

Name Type Description Default
request CreateCustomDetectionRuleAssociationInput | CreateCustomDetectionRuleAssociationInputDict | 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[CreateCustomDetectionRuleAssociationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateCustomDetectionRuleAssociationOutput

An instance of CreateCustomDetectionRuleAssociationOutput.

create_custom_detection_rule_association async

Enables a custom detection rule for your account by creating an association. You specify the rule and the mode in which it operates.

Parameters:

Name Type Description Default
request CreateCustomDetectionRuleAssociationInput | CreateCustomDetectionRuleAssociationInputDict | 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[CreateCustomDetectionRuleAssociationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateCustomDetectionRuleAssociationOutput

An instance of CreateCustomDetectionRuleAssociationOutput.

Input

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

CreateCustomDetectionRuleAssociationInputDict

Bases: TypedDict

Dictionary form of CreateCustomDetectionRuleAssociationInput.

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. Maximum 64 characters.

This field is autopopulated if not provided.

mode instance-attribute
mode: Required[str]

The rule execution mode. Valid values: LIVE | DRY_RUN.

rule_id instance-attribute
rule_id: Required[str]

The unique identifier for the custom detection rule.

tags instance-attribute
tags: Mapping[str, str] | None

The tags to be added to the new custom detection rule association resource.

CreateCustomDetectionRuleAssociationInput dataclass

Bases: _SerdeShape

Dataclass for CreateCustomDetectionRuleAssociationInput 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. Maximum 64 characters.

This field is autopopulated if not provided.

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

The rule execution mode. Valid values: LIVE | DRY_RUN.

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

The unique identifier for the custom detection rule.

tags class-attribute instance-attribute
tags: dict[str, str] | None = ...

The tags to be added to the new custom detection rule association resource.

Output

CreateCustomDetectionRuleAssociationOutput dataclass

Bases: _SerdeShape

Dataclass for CreateCustomDetectionRuleAssociationOutput 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_association class-attribute instance-attribute
rule_association: AssociationDetail | None = ...

The details of the newly created custom detection rule association.