Enables a custom detection rule for your account by creating an association. You specify the rule and the mode in which it operates.
Parameters:
-
rule_id
(Optional[RuleId], default:
None
)
–
The unique identifier for the custom detection rule.
-
mode
(Optional[AssociationMode], default:
None
)
–
The rule execution mode. Valid values: LIVE | DRY_RUN.
-
client_token
(Optional[ClientToken], default:
None
)
–
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. Maximum 64 characters.
-
tags
(Optional[TagMap], default:
None
)
–
The tags to be added to the new custom detection rule association resource.
Raises:
Source code in docs_src/capo_guardduty/_services/guard_duty.py
| def create_custom_detection_rule_association(
self,
*,
config_overrides: Optional[GuardDutyClientConfig] = None,
rule_id: Optional["capo_guardduty.types.rule_id.RuleId"] = None,
mode: Optional["capo_guardduty.types.association_mode.AssociationMode"] = None,
client_token: Optional["capo_guardduty.types.client_token.ClientToken"] = None,
tags: Optional["capo_guardduty.types.tag_map.TagMap"] = None,
) -> "capo_guardduty.types.create_custom_detection_rule_association_response.CreateCustomDetectionRuleAssociationResponse":
"""<p>Enables a custom detection rule for your account by creating an association. You specify the rule and the mode in which it operates.</p>
Args:
rule_id: <p>The unique identifier for the custom detection rule.</p>
mode: <p>The rule execution mode. Valid values: <code>LIVE</code> | <code>DRY_RUN</code>.</p>
client_token: <p>A unique, case-sensitive identifier to ensure that the operation completes no more than one time. Maximum 64 characters.</p>
tags: <p>The tags to be added to the new custom detection rule association resource.</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.create_custom_detection_rule_association_request.CreateCustomDetectionRuleAssociationRequest]",
) -> OperationResponse[
"capo_guardduty.types.create_custom_detection_rule_association_response.CreateCustomDetectionRuleAssociationResponse"
]:
import capo_guardduty._operations.guard_duty_api_service.create_custom_detection_rule_association
output, http_response = (
capo_guardduty._operations.guard_duty_api_service.create_custom_detection_rule_association.create_custom_detection_rule_association(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("CreateCustomDetectionRuleAssociation")
)
input_: capo_guardduty.types.create_custom_detection_rule_association_request.CreateCustomDetectionRuleAssociationRequest = {}
if rule_id is not None:
input_["rule_id"] = rule_id
if mode is not None:
input_["mode"] = mode
if client_token is None:
client_token = str(uuid.uuid4())
input_["client_token"] = client_token
if tags is not None:
input_["tags"] = tags
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|