Skip to content

list_custom_detection_rule_associations async

list_custom_detection_rule_associations(
    *,
    config_overrides: Optional[AsyncGuardDutyClientConfig] = None,
    max_results: Optional[DetectionRuleMaxResults] = None,
    next_token: Optional[String] = None,
    rule_id: Optional[RuleId] = None,
    mode: Optional[AssociationMode] = None,
) -> ListCustomDetectionRuleAssociationsResponse

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

Parameters:

  • max_results (Optional[DetectionRuleMaxResults], default: None ) –

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

  • next_token (Optional[String], default: None ) –

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

  • rule_id (Optional[RuleId], default: None ) –

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

  • mode (Optional[AssociationMode], default: None ) –

    The rule execution mode to filter associations by.

Raises:

Source code in docs_src/capo_guardduty/_services/async_guard_duty.py
async def list_custom_detection_rule_associations(
    self,
    *,
    config_overrides: Optional[AsyncGuardDutyClientConfig] = None,
    max_results: Optional[
        "capo_guardduty.types.detection_rule_max_results.DetectionRuleMaxResults"
    ] = None,
    next_token: Optional["capo_guardduty.types.string.String"] = None,
    rule_id: Optional["capo_guardduty.types.rule_id.RuleId"] = None,
    mode: Optional["capo_guardduty.types.association_mode.AssociationMode"] = None,
) -> "capo_guardduty.types.list_custom_detection_rule_associations_response.ListCustomDetectionRuleAssociationsResponse":
    """<p>Returns all custom detection rule associations for your account. You can filter by rule ID and mode.</p>

    Args:
        max_results: <p>The maximum number of results to return in a single page. Minimum value of 1, maximum value of 100.</p>
        next_token: <p>A pagination token from a previous response. Use this token to retrieve the next page of results.</p>
        rule_id: <p>The unique identifier for the custom detection rule to filter associations by.</p>
        mode: <p>The rule execution mode to filter associations by.</p>

    Raises:
        capo_guardduty.errors.access_denied_exception.AccessDeniedException: <p>An access denied exception object.</p>
        capo_guardduty.errors.bad_request_exception.BadRequestException: <p>A bad request exception object.</p>
        capo_guardduty.errors.internal_server_error_exception.InternalServerErrorException: <p>An internal server error exception object.</p>
        capo_guardduty.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_guardduty.types.list_custom_detection_rule_associations_request.ListCustomDetectionRuleAssociationsRequest]",
    ) -> AsyncOperationResponse[
        "capo_guardduty.types.list_custom_detection_rule_associations_response.ListCustomDetectionRuleAssociationsResponse"
    ]:
        import capo_guardduty._operations.guard_duty_api_service.list_custom_detection_rule_associations

        (
            output,
            http_response,
        ) = await capo_guardduty._operations.guard_duty_api_service.list_custom_detection_rule_associations.async_list_custom_detection_rule_associations(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCustomDetectionRuleAssociations")
    )
    input_: capo_guardduty.types.list_custom_detection_rule_associations_request.ListCustomDetectionRuleAssociationsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if rule_id is not None:
        input_["rule_id"] = rule_id
    if mode is not None:
        input_["mode"] = mode

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output