Skip to content

GuardDuty  >  Operations  >  list_custom_detection_rule_associations

list_custom_detection_rule_associations

Operation

list_custom_detection_rule_associations async

list_custom_detection_rule_associations(input: ListCustomDetectionRuleAssociationsInput, plugins: list[Plugin] | None = None) -> ListCustomDetectionRuleAssociationsOutput

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

Parameters:

Name Type Description Default
input ListCustomDetectionRuleAssociationsInput

An instance of ListCustomDetectionRuleAssociationsInput.

required
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

Returns:

Type Description
ListCustomDetectionRuleAssociationsOutput

An instance of ListCustomDetectionRuleAssociationsOutput.

Input

ListCustomDetectionRuleAssociationsInput dataclass

Dataclass for ListCustomDetectionRuleAssociationsInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | None = 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 = None

The rule execution mode to filter associations by.

next_token class-attribute instance-attribute
next_token: str | None = 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 = None

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

Output

ListCustomDetectionRuleAssociationsOutput dataclass

Dataclass for ListCustomDetectionRuleAssociationsOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = 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 = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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 = None

A list of custom detection rule association summaries.