:doc:`FraudDetector <../../frauddetector>` / Client / update_rule_metadata

********************
update_rule_metadata
********************



.. py:method:: FraudDetector.Client.update_rule_metadata(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/UpdateRuleMetadata>`_  


  **Request Syntax**
  ::

    response = client.update_rule_metadata(
        rule={
            'detectorId': 'string',
            'ruleId': 'string',
            'ruleVersion': 'string'
        },
        description='string'
    )
    
  :type rule: dict
  :param rule: **[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.

      

    
  
  :type description: string
  :param description: **[REQUIRED]** 

    The rule description.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`FraudDetector.Client.exceptions.ValidationException`

  
  *   :py:class:`FraudDetector.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`FraudDetector.Client.exceptions.InternalServerException`

  
  *   :py:class:`FraudDetector.Client.exceptions.ThrottlingException`

  
  *   :py:class:`FraudDetector.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`FraudDetector.Client.exceptions.ConflictException`

  