Skip to content

list_custom_detection_rule_associations

Operation

list_custom_detection_rule_associations

Returns all custom detection rule associations for your account. You can filter by rule ID and mode.

Parameters:

Name Type Description Default
request ListCustomDetectionRuleAssociationsInput | ListCustomDetectionRuleAssociationsInputDict | 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[ListCustomDetectionRuleAssociationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListCustomDetectionRuleAssociationsOutput

An instance of ListCustomDetectionRuleAssociationsOutput.

list_custom_detection_rule_associations async

Returns all custom detection rule associations for your account. You can filter by rule ID and mode.

Parameters:

Name Type Description Default
request ListCustomDetectionRuleAssociationsInput | ListCustomDetectionRuleAssociationsInputDict | 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[ListCustomDetectionRuleAssociationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListCustomDetectionRuleAssociationsOutput

An instance of ListCustomDetectionRuleAssociationsOutput.

Input

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

ListCustomDetectionRuleAssociationsInputDict

Bases: TypedDict

Dictionary form of ListCustomDetectionRuleAssociationsInput.

Attributes

max_results instance-attribute
max_results: int | None

The maximum number of results to return in a single page. Minimum value of 1, maximum value of 100.

mode instance-attribute
mode: str | None

The rule execution mode to filter associations by.

next_token instance-attribute
next_token: str | None

A pagination token from a previous response. Use this token to retrieve the next page of results.

rule_id instance-attribute
rule_id: str | None

The unique identifier for the custom detection rule to filter associations by.

ListCustomDetectionRuleAssociationsInput dataclass

Bases: _SerdeShape

Dataclass for ListCustomDetectionRuleAssociationsInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to return in a single page. Minimum value of 1, maximum value of 100.

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

The rule execution mode to filter associations by.

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

A pagination token from a previous response. Use this token to retrieve the next page of results.

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

The unique identifier for the custom detection rule to filter associations by.

Output

ListCustomDetectionRuleAssociationsOutput dataclass

Bases: _SerdeShape

Dataclass for ListCustomDetectionRuleAssociationsOutput structure.

Attributes

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

A pagination token to retrieve the next page of results. If this field is empty, there are no additional results.

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_associations class-attribute instance-attribute
rule_associations: list[AssociationSummary] | None = ...

A list of custom detection rule association summaries.