Skip to content

list_custom_detection_rule_org_configurations

Operation

list_custom_detection_rule_org_configurations

Returns all organization-level configurations for custom detection rules. You can filter the results by status.

Parameters:

Name Type Description Default
request ListCustomDetectionRuleOrgConfigurationsInput | ListCustomDetectionRuleOrgConfigurationsInputDict | 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[ListCustomDetectionRuleOrgConfigurationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListCustomDetectionRuleOrgConfigurationsOutput

An instance of ListCustomDetectionRuleOrgConfigurationsOutput.

list_custom_detection_rule_org_configurations async

Returns all organization-level configurations for custom detection rules. You can filter the results by status.

Parameters:

Name Type Description Default
request ListCustomDetectionRuleOrgConfigurationsInput | ListCustomDetectionRuleOrgConfigurationsInputDict | 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[ListCustomDetectionRuleOrgConfigurationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListCustomDetectionRuleOrgConfigurationsOutput

An instance of ListCustomDetectionRuleOrgConfigurationsOutput.

Input

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

ListCustomDetectionRuleOrgConfigurationsInputDict

Bases: TypedDict

Dictionary form of ListCustomDetectionRuleOrgConfigurationsInput.

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.

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.

status instance-attribute
status: str | None

The configuration status to filter by.

ListCustomDetectionRuleOrgConfigurationsInput dataclass

Bases: _SerdeShape

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

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.

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

The configuration status to filter by.

Output

ListCustomDetectionRuleOrgConfigurationsOutput dataclass

Bases: _SerdeShape

Dataclass for ListCustomDetectionRuleOrgConfigurationsOutput structure.

Attributes

configurations class-attribute instance-attribute
configurations: list[DetectionRuleOrgConfigurationSummary] | None = ...

A list of organization configurations for custom detection rules.

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.