update_rule_metadata

update_rule_metadata(**kwargs)

Updates a rule's metadata. The description attribute can be updated.

See also: AWS API Documentation

Request Syntax

response = client.update_rule_metadata(
    rule={
        'detectorId': 'string',
        'ruleId': 'string',
        'ruleVersion': 'string'
    },
    description='string'
)

Parameters

• rule (dict) --

  [REQUIRED]

  The rule to update.

  • detectorId (string) -- [REQUIRED]

    The detector for which the rule is associated.

  • ruleId (string) -- [REQUIRED]

    The rule ID.

  • ruleVersion (string) -- [REQUIRED]

    The rule version.

• description (string) --

  [REQUIRED]

  The rule description.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

Exceptions

• FraudDetector.Client.exceptions.ValidationException
• FraudDetector.Client.exceptions.ResourceNotFoundException
• FraudDetector.Client.exceptions.InternalServerException
• FraudDetector.Client.exceptions.ThrottlingException
• FraudDetector.Client.exceptions.AccessDeniedException
• FraudDetector.Client.exceptions.ConflictException