update_custom_detection_rule_association ¶

update_custom_detection_rule_association(
    rule_id: RuleId,
    association_id: AssociationId,
    *,
    config_overrides: Optional[GuardDutyClientConfig] = None,
    mode: Optional[AssociationMode] = None,
) -> UpdateCustomDetectionRuleAssociationResponse

Updates the mode of an existing custom detection rule association.

Parameters:

rule_id (RuleId) –

The unique identifier for the custom detection rule.
association_id (AssociationId) –

The unique identifier for the association to update.
mode (Optional[AssociationMode], default: None ) –

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

Raises:

AccessDeniedException –

An access denied exception object.
BadRequestException –

A bad request exception object.
ConflictException –

A request conflict exception object.
InternalServerErrorException –

An internal server error exception object.
ResourceNotFoundException –

The requested resource can't be found.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_guardduty/_services/guard_duty.py

def update_custom_detection_rule_association(
    self,
    rule_id: "capo_guardduty.types.rule_id.RuleId",
    association_id: "capo_guardduty.types.association_id.AssociationId",
    *,
    config_overrides: Optional[GuardDutyClientConfig] = None,
    mode: Optional["capo_guardduty.types.association_mode.AssociationMode"] = None,
) -> "capo_guardduty.types.update_custom_detection_rule_association_response.UpdateCustomDetectionRuleAssociationResponse":
    """<p>Updates the mode of an existing custom detection rule association.</p>

    Args:
        rule_id: <p>The unique identifier for the custom detection rule.</p>
        association_id: <p>The unique identifier for the association to update.</p>
        mode: <p>The rule execution mode. Valid values: <code>LIVE</code> | <code>DRY_RUN</code>.</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.conflict_exception.ConflictException: <p>A request conflict exception object.</p>
        capo_guardduty.errors.internal_server_error_exception.InternalServerErrorException: <p>An internal server error exception object.</p>
        capo_guardduty.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_guardduty.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_guardduty.types.update_custom_detection_rule_association_request.UpdateCustomDetectionRuleAssociationRequest]",
    ) -> OperationResponse[
        "capo_guardduty.types.update_custom_detection_rule_association_response.UpdateCustomDetectionRuleAssociationResponse"
    ]:
        import capo_guardduty._operations.guard_duty_api_service.update_custom_detection_rule_association

        output, http_response = (
            capo_guardduty._operations.guard_duty_api_service.update_custom_detection_rule_association.update_custom_detection_rule_association(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateCustomDetectionRuleAssociation")
    )
    input_: capo_guardduty.types.update_custom_detection_rule_association_request.UpdateCustomDetectionRuleAssociationRequest = {
        "rule_id": rule_id,
        "association_id": association_id,
    }
    if mode is not None:
        input_["mode"] = mode

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output